Extended title underline in HISTORY.rst to fix twine error #334
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
fix twine error
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.
After creating release candidate 2023.08.0, github actions showed the following error when trying to upload to pypi:
Using
twine check dist/*locally, I found the error was caused by the newly added title underline in HISTORY.rst being too short:2023.08.0 (2023-08-03) ------------------At first I was bit puzzled because I had copied this directly from the output of
generate_release_notes.py, however previous release summaries inHISTORY.rstcontained long enough title underlines.Maybe it'd be a good addition to
generate_release_notes.pyto automatically adapt the title underline to the title determined by the version. Also, it could make sense to include the suggestion totwine check dist/*in the release guide.Something else to mention here is that twine warns
WARNING `long_description_content_type` missing. defaulting to `text/x-rst`., which might be relevant for #306.This PR corrects the title underline and will lead to a new release candidate.