Sync CHANGELOG.md with GitHub releases and automate release notes#50
Merged
Conversation
- Rewrite CHANGELOG.md in Keep a Changelog format, adding a section for every published GitHub release (v0.1-pr.1 through v0.3.1), splitting the stale "Unreleased" content into the v0.3.0/v0.3.1 sections it actually shipped in. - Add scripts/changelog.sh with `extract` and `finalize` subcommands to read/update CHANGELOG.md sections programmatically. - Makefile: add `changelog-check`, wire it into `release-check`, and have `release` finalize the "Unreleased" section into a dated version heading, commit it, then tag and push. - publish.yml: extract the pushed tag's CHANGELOG.md section and pass it to goreleaser via --release-notes, so the GitHub release body matches CHANGELOG.md exactly instead of goreleaser's raw commit-list changelog. - Update docs/release.md to describe the new automated flow. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Cross-checked every commit against every release section: - Add a missing v0.3.0 entry for the -extra-padding flag (adds a blank line after most semicolons), which was previously only mentioned in passing in the v0.3.1 notes. - v0.2-pr.2: note the curly-brace line-break fix that shipped alongside the 80-char line length feature. - v0.2-pr.1: the flag is -v only, there is no separate -version alias. - v0.1-pr.1: remove an inaccurate array-constructor claim; that rule actually shipped in v0.1-pr.2. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Summary
make releasenow finalizes the Unreleased section into a dated version heading, commits it, then tags and pushes — no more manual CHANGELOG editing before releasing.Testing
make all(build + test) passes.make release-check VERSION=x.y.zlocally with a temporary dummy Unreleased entry — passes goreleaser check + snapshot release using extracted notes.make release VERSION=x.y.zdry run in an isolated scratch clone against a local bare remote to confirm the finalize -> commit -> tag -> push flow works correctly end-to-end.