Skip to content

fix(release): repair the 5.1.0 changelog, PR body and draft notes - #220

Merged
derrickmehaffy merged 1 commit into
mainfrom
fix/changelog-blank-line
Aug 14, 2026
Merged

fix(release): repair the 5.1.0 changelog, PR body and draft notes#220
derrickmehaffy merged 1 commit into
mainfrom
fix/changelog-blank-line

Conversation

@derrickmehaffy

Copy link
Copy Markdown
Contributor

#219 broke the changelog in #217. Every section renders as two lists with a gap
down the middle:

### Bug Fixes

* **admin:** stop the settings table logging a React error on every render (#215)
* **release:** fold the beta changelog into the release that supersedes it (#219)
                          ← blank line ends the list
* **admin:** make the panel work in a production build, and test it (#184)
* await the cache purge instead of deferring it to onCommit

The consolidation joined the two runs of entries with a separator:

existing.entries = [...trimBlank(existing.entries), '', ...trimBlank(group.entries)];

A blank line inside a markdown list ends it. Removed, and both runs are stripped
of blank lines before joining.

I said that change was verified. It wasn't.

I checked entry counts (36 = 3 + 33), heading order, and the maximum run of
consecutive blank lines. None of those can see a single blank line between two
list items
— the count is right, the order is right, and the run length is 1.

The check that finds it looks for exactly that shape, and now runs against the
output:

=== blank line between two '* ' entries ===
  line 234  ← 4.0.0-alpha.0, present in the input, deliberately untouched

Zero new splits; the 5.1.0 section is one contiguous list per subsection:

### Features
* add a cache statistics endpoint for the admin dashboard
* add an opt-in content API purge endpoint
* **admin:** rewrite the admin panel in TypeScript and add a dashboard (#181)
…

The already-broken branch

release-please regenerates CHANGELOG.md on the release branch from main on
each run, so once this lands the next run rebuilds it and the fixed fold applies.
I will confirm that on #217 rather than assume it — and if the branch does not
regenerate, deleting it makes release-please recreate it cleanly.

🤖 Generated with Claude Code

The consolidation put a blank line between the stable entries and the folded-in
prerelease entries. A blank line inside a markdown list ends it, so every
section in the 5.1.0 release PR rendered as two separate lists with a gap down
the middle.

The separator is removed and both runs of entries are filtered of blank lines
before being joined, so a section is one list.

I claimed the previous change was verified. It was not: I checked entry counts,
heading order and the maximum run of consecutive blank lines, none of which can
see a single blank line sitting between two list items. The check that finds it
is looking for exactly that, and it now runs against the output: no blank line
between consecutive entries anywhere in the 5.1.0 section.

The one remaining split is in the 2022 4.0.0-alpha.0 section, is present in the
input, and is left alone.

Co-Authored-By: Claude <noreply@anthropic.com>
@derrickmehaffy
derrickmehaffy merged commit 3c68683 into main Aug 14, 2026
12 checks passed
@derrickmehaffy
derrickmehaffy deleted the fix/changelog-blank-line branch August 14, 2026 05:27
@github-actions github-actions Bot mentioned this pull request Aug 14, 2026
@derrickmehaffy derrickmehaffy changed the title fix(release): stop the folded changelog rendering as two lists fix(release): repair the 5.1.0 changelog, PR body and draft notes Aug 14, 2026
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