-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
PEP 101: Remove DE tasks #4574
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
PEP 101: Remove DE tasks #4574
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arguably this step could be kept (modulo whoever does the checking), there have been recent releases where the docs haven't built properly, so it was important to check, even though CI failing/hanging alerted us to this.
A
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's not actually a step in the automation scripts at https://github.com/python/release-tools that does this (or pauses to get someone to check it), other than the CI passing.
We could add one, if we can define something useful?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arguably at minimum, the HTML files should seem fine at dip-test level, the EPUB file should pass EPUBcheck, the PDF archives should contain the expected files & not be corrupt, etc. These feel like reasonable checks?
A
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @AA-Turner's recommendation to add a minimum inspection of some of the doc artifacts. I would specifically add peeks at the HTML version of the What's New page and especially the changelog page as the latter is generated during the build process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, no need for me to do so, but if someone in the release team could just hit refresh on docs.python.org to see if everything is OK it would be nice.
There's multiple places in the PEP 101 that tells about "checking the doc" maybe it could be merged and pushed a bit downwards. like « If it's a new branch [...] verify that the online docs are building properly » no, no, verify, new branch or not, just check the page.
I'm glad we automated docsbuild-script to the point that almost all docs steps were removed from PEP 101.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see PR python/release-tools#320 to test EPUB after the docs artifact build.
@willingc
willingc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't object to someone from the Docs Community doing a spot check of the release. That said, I'm not sure that there needs to be a dedicated resource to do so.
Uh oh!
There was an error while loading. Please reload this page.
Since python/release-tools#71 the docs have been automatically built in the CI and there's no manual tasks for the Docs Expert as part of PEP 101.
cc @JulienPalard
📚 Documentation preview 📚: https://pep-previews--4574.org.readthedocs.build/pep-0101/