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

Pass exit code along with sphinx-build #3

Open
iSOLveIT opened this issue Jul 26, 2023 · 0 comments
Open

Pass exit code along with sphinx-build #3

iSOLveIT opened this issue Jul 26, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@iSOLveIT
Copy link
Owner

By @printfinn

I was trying to fail a Github Action early if there are warning/errors from sphinx build, for example, some images are missing, then there should be some warnings raised by sphinx-build.

If a step exits with a number other than 0, for example: exit(2), a Github Action can capture the errors, and stop the work flow earlier, and that build won't be pushed to the production website.

If I use only sphinx-build in a Github Action yaml file, the Github Action does stop early with a error, this is the expected behavior:

Screenshot 2023-07-26 at 13 50 19

But when I use sphinx-pdf-generate, I found that Github Action is not stopping even if there are errors generated from sphinx-build (called internally be sphinx-pdf-generate):

Screenshot 2023-07-26 at 13 51 04

When I see an error, I know I have mistakes, so I can fix the code:

Screenshot 2023-07-26 at 14 49 13
@iSOLveIT iSOLveIT added the bug Something isn't working label Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant