docs(release): curated user-facing release notes via CHANGELOG.md - #48
Merged
Conversation
Release notes were just GitHub's raw auto-generated PR list. Add a hand-written, user-facing CHANGELOG.md covering every release, and wire the release workflow to use the matching version section as the release body (GitHub's "What's Changed" PR list still appends after it). Add tools/backfill-release-notes.ps1, which rewrote the notes on all existing releases from the same CHANGELOG. 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.
Why
Release notes were just GitHub's raw auto-generated PR list — developer-oriented, not informative to users.
What
CHANGELOG.md— a hand-written, user-facing summary of every release (v0.1.0 → v0.1.52), newest first.release.yml— the release workflow now pulls the matching## [x.y.z]section from CHANGELOG.md into the release body (falling back to[Unreleased]). GitHub's "What's Changed" PR list and Full Changelog link still append after it.tools/backfill-release-notes.ps1— reusable script that rewrites notes on existing releases from CHANGELOG.md. Already run against all 53 existing releases, which now show curated notes.Notes
pwsh(PowerShell Core, UTF-8 by default); the backfill script is explicit about UTF-8 so it's correct under Windows PowerShell 5.1 too.🤖 Generated with Claude Code