feat(release): auto-generate release notes from Conventional Commits#78
Merged
Conversation
The release body was a static 'Installation + Binaries' template — every release looked identical with zero mention of what changed. Append a 'What's Changed' section generated from `git log <prev-tag>..<version>`, grouped by conventional-commit type (Features / Bug Fixes / Performance / Refactors / Docs / Tests / Chores / CI), with a Full Changelog compare link. Skipped on the first release (no prior tag to compare). Non-conventional commits are dropped — CLAUDE.md already enforces the convention so this should be rare, and silence is better than a misleading row. Codifies the pattern in docs/HARNESS.md so the next agent that goes to edit release notes manually finds the generator step instead.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
The release body was a static "Installation + Binaries" template — every release looked identical with zero mention of what changed. v0.58.0 is the latest example: bundled both #76 (the new progress bar) and #77 (the fixes), but the GitHub release page tells the user nothing about either.
Append a "What's Changed" section generated from
git log <prev-tag>..<version>, grouped by Conventional Commit type (Features / Bug Fixes / Performance / Refactors / Docs / Tests / Chores / CI), with a Full Changelog compare link.Validated locally against
v0.57.0..v0.58.0:Harness rationale
Per
docs/HARNESS.md, repeated friction becomes a control. "Release notes are blank" was previously the kind of thing that gets noticed AFTER each release. Encoding it as a workflow step means the next release (and every release after) writes them automatically — no manual step to forget. Added a row to the controls table so the next agent that goes looking for "where is this generated" finds it directly.What this does NOT do
gh release editafter mergeauto-release.yml— release dispatch logic untouchedTest plan
v0.57.0..v0.58.0, output matches the expected groupingfeat:andfeat(scope):formsgit describe --tags --abbrev=0 ^returns empty → skip the "What's Changed" section entirely)release.ymlwill validate end-to-end (workflow_dispatch can also be used to re-run for v0.58.0 once this lands)