docs: bump CHANGELOG footer link-references when cutting a release#48
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
github-actions
Bot
added
documentation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the release process documentation to clarify the steps for updating the CHANGELOG.md footer link-references. The feedback suggests wrapping literal link references and placeholders in backticks to prevent markdown parsers from treating them as broken links and to improve readability.
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 GitHub release skill’s reference release process to explicitly include updating Keep a Changelog footer link-references when cutting a release, preventing dangling [Unreleased]: refs and missing version compare links.
Changes:
- Expands Phase 1 instructions to include bumping CHANGELOG footer link-references alongside the new version section.
- Documents why footer references can silently drift and be flagged by reviewers/bots.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CybotTM
force-pushed
the
docs/changelog-footer-link-refs-on-release
branch
from
cd2517f to
0abb236
Compare
…heading Keep-a-Changelog footer compare-links drift silently: repoint [Unreleased] to vNEW...HEAD and add [vNEW]: compare/vPREV...vNEW when cutting a release, else a reviewer bot flags the dangling [Unreleased]: ref (and a prior version's link may be missing entirely). Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
CybotTM
force-pushed
the
docs/changelog-footer-link-refs-on-release
branch
from
0abb236 to
9879765
Compare
|
Field-tested on netresearch/t3x-nr-llm v0.14.0: replacing the
## [Unreleased]heading with the new version but leaving the Keep-a-Changelog footer link-references untouched left a dangling[Unreleased]:ref (still pointing atv0.12.0...HEAD) and a missing[0.13.0]compare link — which the PR reviewer bot correctly flagged.Augments Phase 1 of
release-process.md: when updating CHANGELOG.md, repoint[Unreleased]tovNEW...HEADand add[vNEW]: .../compare/vPREV...vNEW, not just the section heading.