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

Builds: Add notification if PDF build command fails (!= 0) #10549

Open
2 tasks
humitos opened this issue Jul 19, 2023 · 5 comments
Open
2 tasks

Builds: Add notification if PDF build command fails (!= 0) #10549

humitos opened this issue Jul 19, 2023 · 5 comments

Comments

@humitos
Copy link
Member

humitos commented Jul 19, 2023

Some time ago we made the build to fail if the PDF command was different than 0: #10113. However, we had to revert this because it affected a lot of users and the instructions about how to solve the problem was not clear. See #10158

So, we want to discuss if we want to deprecate this functionality, we need to do more work to move it forward. If not, we can keep the status quo.

Some potential work here:

  • Decide if we are just skipping on this change
  • Notify users of the change so they can address issues

I think we should probably use the our new and shiny "deprecation path" that involves sending weekly emails to the affected projects/users, plus writing a blog post with exact dates, etc.

@humitos humitos changed the title Revisit deprecation of default on PDF builds Builds: fail build if PDF command fails (!= 0) Jul 19, 2023
@humitos
Copy link
Member Author

humitos commented Aug 10, 2023

We talked about this in a meeting and some ideas came up:

  • create a fail-on-warning config key specifically for PDF
  • keep the current behavior and show a build notification explaining there was a LaTeX error, but a PDF was created anyways and Read the Docs didn't fail the build

Since creating a new config key is not a trivial amount of work, I understand we will start with a notification first and see how it goes.

@humitos
Copy link
Member Author

humitos commented Aug 26, 2023

keep the current behavior and show a build notification explaining there was a LaTeX error, but a PDF was created anyways and Read the Docs didn't fail the build

This is related with the new build notification system: #10598

@ericholscher
Copy link
Member

ericholscher commented Apr 9, 2024

As we build build.jobs.build.pdf we will plan to respect the error codes, the main thing here is backwards compat for LaTeX which has wonky error codes.

We could also add a new notification that warns users about this.

@ericholscher ericholscher changed the title Builds: fail build if PDF command fails (!= 0) Builds: Add notification if PDF build command fails (!= 0) Jul 2, 2024
@lwasser

This comment was marked as off-topic.

@humitos

This comment was marked as off-topic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Planned
Development

No branches or pull requests

3 participants