Lint changelog placement in PRs (new entries under Unreleased)#4513
Draft
dragonstyle wants to merge 2 commits into
Draft
Lint changelog placement in PRs (new entries under Unreleased)#4513dragonstyle wants to merge 2 commits into
dragonstyle wants to merge 2 commits into
Conversation
New CHANGELOG.md lines must land in the '## Unreleased' section. Allows typo fixes in released sections (paired-edit hunks), creating the header after a release, and release-prep renames of Unreleased to a version header. Failures annotate the offending lines in the PR diff view. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
A small self-contained CI check that runs only when a PR modifies
CHANGELOG.md, and verifies new entries land under the## Unreleasedsection.Passes:
## Unreleased— including creating the header (the first entry after a release)## Unreleasedto a version header — releases aren't blockedFails, with line-level annotations in the diff view:
## Unreleasedwas just consumed)## Unreleasedsection exists (fix: add one at the top)Why
The changelog is hand-curated and high-traffic; misplaced entries surface as missing release notes and get caught late (or not at all). This makes placement mistakes visible at PR time instead.
Notes
checkout.permissions: contents: read.🤖 Generated with Claude Code