Check for reStructuredText syntax errors in README+NEWS while running release command #3556
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
khaledhosny
approved these changes
May 31, 2024
setup_requires is deprecated, and relying on it to bootstrap the readme_renderer sometimes fails, better to ensure it's already pip installed before running release command
anthrotype
force-pushed
the
check-rst-syntax-before-release
branch
from
b83bcd3
to
162cacb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
it happened a few times that one updates the NEWS.rst and doesn't check that it is still valid reStructuredText, only to find out later on while publishing the wheels that the
long_descriptioncontains syntax error and would display as plain text on PyPI.This ensures that we run the
readme_rendererto render the .rst and check for any syntax errors before it proceeds to bump the version in the samepython setup.py releasecommand.This is the same thing that
twine checkdoes when verifying the metadata of a package.I can't easily add a test for this, but rest assured that I have tried locally a few times and it works.
The release workflow does not change. The only gotcha is that it's preferable to install bump2version and readme_renderer in the venv before running
setup.py release, otherwise the old (deprecated)setup_requiresegg installation method would be used to fetch them and sometimes this fails forpackage_readmefor reasons that I haven't figured out.