Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Running composer docs:db fails #1437

Open
stweil opened this issue Jan 23, 2025 · 5 comments · May be fixed by #1486
Open

[BUG] Running composer docs:db fails #1437

stweil opened this issue Jan 23, 2025 · 5 comments · May be fixed by #1486
Assignees
Labels
🐛 bug A non-security related bug.

Comments

@stweil
Copy link
Member

stweil commented Jan 23, 2025

Description

Several documentation files were build using composer docs:db, but this command no longer works with the latest main branch installed on TYPO3 v11.

The command tries to execute Build/Documentation/dbdocs/generate.php which fails to find vendor/autoload.php (might require different paths for TYPO3 v11 and TYPO3 v12 or later).

@sebastian-meyer sebastian-meyer added the 🐛 bug A non-security related bug. label Jan 31, 2025
@sebastian-meyer
Copy link
Member

@thomaslow could that be a side-effect of #1337?

@thomaslow
Copy link
Contributor

I'll look into it.

@sebastian-meyer
Copy link
Member

Thank you, @thomaslow!

@thomaslow thomaslow linked a pull request Feb 13, 2025 that will close this issue
1 task
@thomaslow
Copy link
Contributor

I investigated the compose docs:db command. It is used to generate the reStructuredText file Documentation/Developers/Database.rst, which has not been updated in the last 3 years.

I'm not sure why the code is located in the Build/Documentation/dbdocs directory. I guess the idea was that it isn't code that is needed at runtime. On the other hand, the code requires access to the database in order to extract information about the database schema.

In order to make this work, the generate.php somehow configures a custom typo3 environment based on the classic non-composer based typo3 directory structure, which is why there is a symbolic link Build/Documentation/dbdocs/public/typo3.

Anyway. My suggestion would be to move this code to the Classes/Command directory and register a new typo3 command kitodo:dbdocs that will trigger the generation process of the documentation file.

I added the pull request #1486 to demonstrate my proposal. What do you think?

@sebastian-meyer
Copy link
Member

Yes, that seems reasonable! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug A non-security related bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants