docs(changelog): per-version keep-a-changelog entries (RAN-61)#83
Merged
docs(changelog): per-version keep-a-changelog entries (RAN-61)#83
Conversation
Replace the meta-pointer CHANGELOG with keep-a-changelog v1.1.0 format plus per-version sections for v0.0.1 / v0.0.2 / v0.0.3 so the bestpractices.dev autofill can flip release_notes_status from "Unmet — No release notes file found" to Met (target: 43/43 MUST on project 12628). The header documents the format, SemVer, and the existing release.yml workflow so future releases keep this file in sync. Co-Authored-By: Paperclip <noreply@paperclip.ing> Co-Authored-By: Claude Opus 4.7 (1M context) <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
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
Replaces the meta-pointer
CHANGELOG.mdwith keep-a-changelog 1.1.0 format plus per-version sections forv0.0.1,v0.0.2, andv0.0.3.The bestpractices.dev autofill scans for per-version headers and skips meta files, so the previous file kept
release_notes_statusstuck atUnmet — No release notes file foundand held project 12628 at 42/43 MUST. With per-version headers in place, a board-side re-trigger of the autofill should flip the criterion to Met (target: 43/43 MUST).What changed
CHANGELOG.mdwith keep-a-changelog headers (## [0.0.3] — 2026-04-23, etc.).### Added,### Changed,### Fixed,### Security,### Upgrade impact,### Known limitations) sourced from the existing GitHub Release bodies.release.ymlworkflow so future releases keep entries in sync.Out of scope (per RAN-61 description)
gh releasenotes —release.ymlisworkflow_dispatch-only withnotesas a required input; rewriting historic releases is a separate ask.release.ymlon release — track separately if desired.Test plan
release_notes_statusflips to Met (43/43 MUST).Closes RAN-61.
🤖 Generated with Claude Code