🐛 fix(release): generate docstrfmt-compatible changelog entries#463
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Mar 5, 2026
Merged
🐛 fix(release): generate docstrfmt-compatible changelog entries#463gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
The release workflow generated RST section headers that docstrfmt reformats: overline/underline was same width as title (docstrfmt wants +1), and the blank line after the underline was missing. Also fix _load_excluded_authors to use .yaml extension after the .github files were renamed in b10b8c5.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The release workflow generates RST section headers for new changelog entries that
docstrfmtimmediately reformats, causing pre-commit.ci to fail on every release commit. This happened on 4.9.4 (pre-commit.ci run) and was silently auto-fixed on earlier releases (4.9.2, etc.) by subsequent pre-commit.ci autoupdate PRs.🔧 Two formatting issues: the
*overline/underline separator matched the title length exactly, butdocstrfmtexpects it to be one character wider (to account for the leading space in RST overlined headers). Additionally, no blank line was emitted between the section underline and the bullet list. Both are now corrected in theprintfformat string.A secondary bug is also fixed:
_load_excluded_authorsintasks/changelog.pystill referenced.github/release.yml, which was renamed to.github/release.yamlin b10b8c5. This caused bot commits (dependabot[bot],pre-commit-ci[bot]) to appear in the 4.9.4 changelog instead of being filtered out.