fix(release-prepare): populate and backfill CHANGELOG entries#47
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Code Review
This pull request updates the release preparation documentation with detailed instructions on how to properly populate and update the CHANGELOG.md file. The review feedback suggests adding a fallback to the git command for repositories without existing tags, and updating the instructions to include modifying the link references at the bottom of Keep a Changelog files to prevent validation script failures.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
Updates the /release-prepare command documentation to ensure CHANGELOG generation produces a populated release entry by deriving content from git history and backfilling missing tagged versions, preventing “hollow” releases when [Unreleased] is empty.
Changes:
- Replace the “rename
[Unreleased]” instruction with guidance to derive release notes fromgit log <last-tag>..HEAD. - Add instructions to backfill missing CHANGELOG sections for already-tagged versions.
- Clarify insertion rules for Keep a Changelog vs. other CHANGELOG formats.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
aab68c4 to
6776f3c
Compare
…mpty section Step 6 only renamed [Unreleased] -> [X.Y.Z]. When changes are merged PR-by-PR without touching the changelog, [Unreleased] is empty and the rename produces a hollow version heading. Derive entries from the commit log since the last tag, backfill any prior versions that shipped without an entry, and match the file's existing style. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
6776f3c to
9c8e806
Compare
|



/release-preparestep 6 only renamed[Unreleased]→[X.Y.Z]. When changes land PR-by-PR without touching the changelog,[Unreleased]is empty and the rename yields a hollow version heading — which is exactly what happened across the last release batch (jira, matrix, netresearch-jira, it-maintenance all needed manual changelog entries + backfill after the fact; Copilot flagged jira-skill#151).Step 6 now: derive entries from
git log <last-tag>..HEAD, backfill any prior versions missing from the changelog, and add the new section in the file's own format. Never rename an empty section.