feat(release): changelog fragments — parallel-safe changelog authoring - #62
Merged
Conversation
CHANGELOG.md's [Unreleased] section is the most-conflicted file in parallel development (touched by a third of integrations in the blast-radius review). A PR now drops changelog.d/<topic>.<type>.md — one markdown paragraph, no leading '- ' — and two PRs never touch the same line again. - scripts/assemble-changelog.sh folds fragments into [Unreleased] (creates ### sections in Keep-a-Changelog order, deletes consumed fragments); --check validates fragment format only and runs in the quick CI gate job - scripts/release.sh now runs the assemble itself and retitles [Unreleased] to '## [<ver>] — date' with a fresh empty [Unreleased] on top: the one manual step left in a release is gone (a hand-retitled heading and direct [Unreleased] edits stay legal — fragments are preferred, not required) - gate selftest: run_case learns gate arguments; new case renames the tracked changelog.d/README.md into a bad-typed fragment and requires --check to name it — 20 planted breakages across nine gate scripts - docs: CONTRIBUTING Changelog+Release sections, changelog.d/README.md, INDEX, CLAUDE.md
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.
CHANGELOG.md is touched in a third of all integrations — the single most conflict-prone file for parallel work (blast-radius review data). Fragments end that.
changelog.d/<topic>.<added|changed|fixed|removed|security>.md— one markdown paragraph per PR, no shared file to conflict on. This PR dogfoods its own fragment.scripts/assemble-changelog.shfolds fragments into[Unreleased](creates sections in canonical order);--checkvalidates format only and runs as a fast CI step. Direct[Unreleased]edits stay legal (documented as transitional).release.sh <ver>now does assemble → retitle[Unreleased]→ all version bumps in one command (the manual heading rename was the only human mechanical step left; content still comes from humans — in the fragments). Manual pre-retitle still accepted; empty Unreleased and orphan fragments fail loudly.Live-verified end-to-end: fragment → assemble → release.sh 1.6.0 on a scratch tree bumped everything and passed version-sync. Gates + selftest 20/20 green.