Repository navigation
python(chore): lint changelog fragment shapes and PR numbers - #865
Merged
Merged
Conversation
A fragment is now one paragraph or a highlight with a title, summary, and details. The template renders the highlight summary as a bullet with a link and the details once under Highlights. release_version.py gains --lint, and the changelog check lints the fragments a PR adds or changes and requires added fragments to use the PR number.
alexluck-sift
marked this pull request as ready for review
November 3, 2026 21:00
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
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.
Summary
Changelog fragments now take one of two shapes, and the changelog check enforces them. A one-paragraph fragment renders as a bullet under its type. A highlight (
# Title, blank line, summary paragraph, details) renders its summary as a bullet with a link, and its details once under a### Highlightssection after the type lists.release_version.py --linton the fragments a PR adds or changes. It rejects emptybreaking/feat/fixfragments, non-emptychorefragments, multi-paragraph fragments without a title, extra headings, and unlabeled or unclosed code blocks.<PR>.<type>.md. A+namefragment is fine while drafting but fails the check until renamed. Existing fragments that a PR only changes keep their names.python/changelog.d/README.mdhas examples of both shapes and the rendered output.