Skip to content

docs: give today's three releases their changelog compare links - #217

Merged
blaipr merged 1 commit into
mainfrom
docs/changelog-compare-links
Sep 1, 2026
Merged

docs: give today's three releases their changelog compare links#217
blaipr merged 1 commit into
mainfrom
docs/changelog-compare-links

Conversation

@blaipr

@blaipr blaipr commented Sep 1, 2026

Copy link
Copy Markdown
Member

The reference-link block at the bottom of CHANGELOG.md stopped at 0.24.0. Three releases cut today — 0.24.1, 0.25.0, 0.26.0 — got their headings but no link definition, so they render as plain text where every release before them links to its own diff.

[Unreleased] was also still comparing against v0.24.0, which hid three releases' worth of changes from anyone following that link.

-[Unreleased]: .../compare/v0.24.0...HEAD
+[Unreleased]: .../compare/v0.26.0...HEAD
+[0.26.0]:     .../compare/v0.25.0...v0.26.0
+[0.25.0]:     .../compare/v0.24.1...v0.25.0
+[0.24.1]:     .../compare/v0.24.0...v0.24.1

41 headings, 41 link definitions, none missing.

The link block stopped at 0.24.0, so the headings for 0.24.1, 0.25.0 and
0.26.0 rendered as plain text while every release before them is a link to
its diff, and [Unreleased] still compared against v0.24.0 -- hiding three
releases' worth of changes from anyone following it.

Keep a Changelog wants a definition per heading; there are now 41 of each.
@blaipr blaipr added the changelog-rewrite Deliberately edits an already-released CHANGELOG section; waives the immutability check label Sep 1, 2026
@blaipr blaipr closed this Sep 1, 2026
@blaipr blaipr reopened this Sep 1, 2026
@blaipr
blaipr merged commit 97ac665 into main Sep 1, 2026
14 of 18 checks passed
@blaipr
blaipr deleted the docs/changelog-compare-links branch September 1, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog-rewrite Deliberately edits an already-released CHANGELOG section; waives the immutability check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant