Skip to content

馃悰 fix(release): format generated changelog - #1170

Merged
layday merged 5 commits into
pypa:mainfrom
gaborbernat:harden-release-format
Aug 28, 2026
Merged

馃悰 fix(release): format generated changelog#1170
layday merged 5 commits into
pypa:mainfrom
gaborbernat:harden-release-format

Conversation

@gaborbernat

@gaborbernat gaborbernat commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Format the generated changelog with docstrfmt 2.2.1 before creating a release commit. v2.2.0 skipped CHANGELOG.rst in GitHub's build/build checkout, leaving the 1.6.0 changelog over 120 columns.

Pin the release dependency and pre-commit hook to v2.2.1, with a package-specific cutoff timestamp so uv can install it before the seven-day window expires. Reformat the existing changelog to match docstrfmt's output.

@gaborbernat gaborbernat added the bug Something isn't working label Aug 27, 2026
@gaborbernat
gaborbernat force-pushed the harden-release-format branch 3 times, most recently from 8fb6987 to 34f2534 Compare August 27, 2026 22:36
@gaborbernat gaborbernat changed the title 馃悰 fix(release): fail when docstrfmt verifies nothing 馃悰 fix(release): fail when the formatting hooks verify nothing Aug 27, 2026
The 1.6.0 job ran the docstrfmt hook three times, was told Passed each
time, and pushed a changelog pre-commit.ci rejects. The hook inspected
no files and exited 0; every existing check keys off a hook failing, so
a formatter doing no work passes them all.

Require docstrfmt to report a non-zero file count, which --verbose
exposes. The separate docstrfmt call goes away with it: it duplicated
the hook's line width and could drift from it.
Nothing in tasks/ invokes docstrfmt now; the hook installs its own,
so the pin and its keep-in-sync note have no reader.
@gaborbernat
gaborbernat force-pushed the harden-release-format branch from f74f5ba to 1dcf53c Compare August 27, 2026 22:45
@gaborbernat
gaborbernat marked this pull request as draft August 28, 2026 15:45
@gaborbernat gaborbernat changed the title 馃悰 fix(release): fail when the formatting hooks verify nothing 馃悰 fix(release): format generated changelog Aug 28, 2026
@gaborbernat
gaborbernat marked this pull request as ready for review August 28, 2026 18:29
@layday
layday merged commit 0ef5a40 into pypa:main Aug 28, 2026
60 checks passed
@gaborbernat
gaborbernat deleted the harden-release-format branch August 28, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants