feat(changelog): auto-draft [Unreleased] from commits (hybrid draft + polish)#523
Merged
Merged
Conversation
… polish) The changelog roll only ever *moved* a hand-authored [Unreleased] into a dated section; nobody kept [Unreleased] filled, so releases shipped blank (0.6.19- 0.6.22 went unrecorded). This makes it a hybrid: a draft is generated from the Conventional-Commit subjects since the last release tag, so there is always something better than nothing, and it is polished by hand when convenient. - generate_commit_draft(): `git log <last-tag>..HEAD` -> classify subjects (feat->Added, fix->Fixed, perf/refactor->Changed; ci/chore/build/style/docs/ test dropped; `!` -> **Breaking:** prefix) -> grouped Keep-a-Changelog body. - Ship fallback: when [Unreleased] is empty, roll_changelog_file rolls the generated draft instead of "nothing to roll" — a release is never blank. Hand-authored [Unreleased] still wins when present. - `just changelog-draft` (ChangelogDraft subcommand): populate [Unreleased] with the draft on demand, to polish before shipping. Never overwrites hand-authored notes. Pure classification + roll + inject logic is unit-tested; verified end-to-end against the real history (produces a clean grouped draft). No new dependency. 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
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.
The durable fix for the stale-changelog problem. The roll only ever moved a hand-authored
[Unreleased]into a dated section — but nobody kept[Unreleased]filled, so 0.6.19–0.6.22 shipped blank. This makes it a hybrid: a draft is generated from Conventional-Commit subjects, so it's never blank, and it's polished by hand when convenient.What it does
generate_commit_draft()—git log <last-tag>..HEAD→ classify subjects (feat→Added,fix→Fixed,perf/refactor→Changed;ci/chore/build/style/docs/testdropped;!→**Breaking:**prefix) → grouped Keep-a-Changelog body, chronological.[Unreleased]is empty,roll_changelog_filerolls the generated draft instead of "nothing to roll." A release is never blank. Hand-authored[Unreleased]still wins when present.just changelog-draft(newChangelogDraftsubcommand) — populate[Unreleased]with the draft on demand, to polish before shipping. Never overwrites hand-authored notes.Verified
Live-ran against the real history — produced a clean grouped draft (Added: the
feat, Fixed: thefixes with scopes + PR links,chore/docsdropped). Pure classify/roll/inject logic is unit-tested (5 new). No new dependency.The workflow now
Draft is always there as a placeholder → polish into narrative once in a while → ship rolls whatever's there. Can't silently go stale again.