Skip to content

docs(changelog): per-version keep-a-changelog entries (RAN-61)#83

Merged
aksOps merged 1 commit intomainfrom
ran-61-changelog
Apr 26, 2026
Merged

docs(changelog): per-version keep-a-changelog entries (RAN-61)#83
aksOps merged 1 commit intomainfrom
ran-61-changelog

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented Apr 26, 2026

Summary

Replaces the meta-pointer CHANGELOG.md with keep-a-changelog 1.1.0 format plus per-version sections for v0.0.1, v0.0.2, and v0.0.3.

The bestpractices.dev autofill scans for per-version headers and skips meta files, so the previous file kept release_notes_status stuck at Unmet — No release notes file found and 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

  • Rewrote CHANGELOG.md with keep-a-changelog headers (## [0.0.3] — 2026-04-23, etc.).
  • Each version section uses keep-a-changelog category headings (### Added, ### Changed, ### Fixed, ### Security, ### Upgrade impact, ### Known limitations) sourced from the existing GitHub Release bodies.
  • Top-of-file documents the format, SemVer adherence, and the existing release.yml workflow so future releases keep entries in sync.
  • Cross-links each version to its tag and PRs.

Out of scope (per RAN-61 description)

  • Back-filling gh release notes — release.yml is workflow_dispatch-only with notes as a required input; rewriting historic releases is a separate ask.
  • Auto-writing CHANGELOG entries from release.yml on release — track separately if desired.

Test plan

Closes RAN-61.

🤖 Generated with Claude Code

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>
@aksOps aksOps enabled auto-merge (squash) April 26, 2026 03:57
@aksOps aksOps merged commit fe0ddbd into main Apr 26, 2026
16 of 17 checks passed
@aksOps aksOps deleted the ran-61-changelog branch April 26, 2026 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant