Skip to content

Build: missing submodule throws exception #9539

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

Closed
agjohnson opened this issue Aug 23, 2022 · 3 comments
Closed

Build: missing submodule throws exception #9539

agjohnson opened this issue Aug 23, 2022 · 3 comments
Labels
Accepted Accepted issue on our roadmap Bug A bug

Comments

@agjohnson
Copy link
Contributor

If a user configures a submodule to use in their readthedocs.yaml, the build command/step to pull submodules will fail with an exception and will not report back to the user that there was a problem.

To reproduce, specify submodules.include: ['submodule-that-doesnt-exist'] in a configuration file.

Here is a test-builds test case, which failed:

https://github.com/readthedocs/test-builds/blob/submodule-not-found/.readthedocs.yaml
https://readthedocs.org/projects/test-builds/builds/17876929/

I would expect that build step to report back to the user that there is a missing submodule.

@agjohnson agjohnson added Bug A bug Accepted Accepted issue on our roadmap labels Aug 23, 2022
@agjohnson agjohnson moved this to Planned in 📍Roadmap Aug 23, 2022
@humitos
Copy link
Member

humitos commented Aug 23, 2022

Looks related or duplicate of #9365

@agjohnson
Copy link
Contributor Author

Yeah, seems related a bit. Definitely related in that the exception is not reported back to the user.

If we do anything here specifically, it could be a command/build failure that "Submodule submodule-that-doesnt-exist was not found". On #9365, that might error message might be a little different perhaps, though I could see both being covered with a generic message too.

@agjohnson
Copy link
Contributor Author

Rolled into #9365

Repository owner moved this from Planned to Done in 📍Roadmap Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
Archived in project
Development

No branches or pull requests

2 participants