Repository navigation
Changelog fragments (ADR 0072) - #199
Merged
Merged
Conversation
Amends ADR 0059: a change adds changes/<slug>.md instead of editing CHANGELOG.md, and just release joins the fragments into Unreleased. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…0072) Each change now adds changes/<slug>.md. scripts/release.sh moves the fragments to the top of Unreleased, newest first-parent merge first, deletes them in the release commit, and lets a stable release with only fragments pass the entry check. Docs, changes/README.md and the release tests follow; the roadmap item is done. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Under set -e, `awk ... >tmp && mv` let a failed redirect continue, so a release could delete fragments without joining them. Co-Authored-By: Claude Opus 5.5 <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.
Finishes the ROADMAP Later item "Changelog fragments" (from the 0.2.1 merges).
changes/<slug>.mdinstead of editing CHANGELOG.md, so parallel PRs stop conflicting on Unreleased.just release(scripts/release.sh) puts the fragments at the top of## Unreleased, newest first-parent merge first (fragments no commit added that way, such as renamed ones, go below by name). It deletes them in therelease: v…commit, for pre-releases too. A stable release passes the entry check with fragments alone. Fragment names and a leading-bullet are validated before any checks run.changes/README.mdgives the format;docs/development.mdand ADR 0059 point to ADR 0072. The existing Unreleased entry stays in CHANGELOG.md, and fragments join above it.scripts/test-release.shcovers the join order (including a--no-ffmerge and a rename), deletion inside the release commit, pre-release joining, and refusal of malformed fragments and empty stable releases.Testing
just test-release: passesjust lint-scripts: cleanCodex review
awk … >tmp && mvunderset -e): fixed in the last commit, for the existing section-naming rewrite as well.🤖 Generated with Claude Code