Skip to content

Release notes: only the changes, with their line breaks - #5

Closed
steeben wants to merge 2 commits into
mainfrom
fix/release-notes-line-breaks
Closed

steeben wants to merge 2 commits into
mainfrom
fix/release-notes-line-breaks

Conversation

@steeben

@steeben steeben commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Requested by Stephen · project thread

Why

Release pages should list the changes, not repeat the README's install steps.

The v0.3.0 release page came out as one long paragraph. In the Notes step, $lead is the lines before the changelog section's first ### heading. For 0.3.0 that was just the blank line under ## 0.3.0, so PowerShell made $lead a single string instead of a list. $lead + $install + $rest then became string concatenation, which joined every line with spaces into one line.

What changed

  • The notes are now only the version's changelog section. The install steps (already in the README) and the reordering around them are gone, so the release page lists just the changes.
  • The section is always kept as an array (@(...)), so it can't collapse into one string.
  • The step throws if a multi-line section comes out as one or two lines, so a flattened body fails the release instead of publishing.

The v0.3.0 release body itself has to be edited separately; this only affects future releases.

https://claude.ai/code/session_01VxULgbL1u1kKKKMpQVvLfA


Generated by Claude Code

The Notes step built the page from three parts, $lead + $install + $rest.
When the changelog section had a single line before its first heading,
$lead was a string rather than a list, so adding the other parts to it
joined every line into one, and 0.3.0's release page came out as a single
paragraph. Each part is now kept as a list, and the step stops if the
notes come out as only a few lines.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VxULgbL1u1kKKKMpQVvLfA
@steeben steeben self-assigned this Oct 22, 2026
The install steps came before the changes on every release page, so the
notes read like the README. They now hold just the changelog section, and
the install steps stay in the README.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VxULgbL1u1kKKKMpQVvLfA
@steeben steeben changed the title Keep the release notes' line breaks Release notes: only the changes, with their line breaks Oct 22, 2026
@steeben steeben closed this Oct 22, 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.

2 participants