docs(changelog): add CHANGELOG.md scaffold + auto-update workflow#24
Merged
docs(changelog): add CHANGELOG.md scaffold + auto-update workflow#24
Conversation
Add Keep a Changelog scaffold with an Unreleased section pointing at GitHub Releases as the authoritative source, plus .github/workflows/update-changelog.yml that prepends each new release body into the file when a Release is published. This makes the release history discoverable in the repo without duplicating maintenance — softprops/action-gh-release's generated notes are the single source of truth, mirrored into the checked-in file.
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.
From the 2026-05-01 followup. Adds the missing CHANGELOG.md so the release history is discoverable from a clone, without doubling maintenance.
What's added
CHANGELOG.md— Keep a Changelog scaffold with## [Unreleased]at the top, link to GitHub Releases as authoritative source..github/workflows/update-changelog.yml— triggered onrelease: published; reads the release body, prepends a dated entry under Unreleased, commits back to main with[skip ci].Why
softprops/action-gh-releasealready runsgenerate_release_notes: truein cd.yml, so GitHub Releases is the source of truth. This workflow mirrors those notes into the checked-in file — readers don't have to leave the repo to see history, and PRs that touch CHANGELOG.md still appear in normal review.Test plan
[Unreleased]