chore(release-notes): unwrap changelog text in release notes; fix [Unreleased] compare base - #134
Conversation
…ased] compare base Two release-notes hygiene items from the v2.3.0 cut: - release.yml now unwraps the extracted changelog section before publishing. CHANGELOG.md is hard-wrapped for the repo view, but GitHub renders release bodies with single newlines as <br>, so the v2.3.0 notes appeared as narrow ragged lines (corrected in place via gh release edit). Fenced blocks and nested bullets pass through. - The [Unreleased] compare link now starts from v2.3.0 instead of v2.2.0 — flagged by Copilot on the release-prep PR; without it the compare shows already-released changes. CONTRIBUTING.md's release steps gain the compare-link re-point and a note that wrapping changelog text is safe. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
There was a problem hiding this comment.
Pull request overview
This PR updates the release hygiene around CHANGELOG.md consumption: it adjusts the [Unreleased] compare base after the v2.3.0 cut, and makes the tag-triggered release workflow unwrap hard-wrapped changelog lines so GitHub Release notes render as intended.
Changes:
- Update
release.ymlto post-process extracted changelog sections, unwrapping hard-wrapped bullet continuations and consolidating consecutive blockquote lines before publishing release notes. - Re-point the
[Unreleased]compare link tov2.3.0...HEAD. - Document the compare-link re-point (and the release-notes unwrapping behavior) in the release steps.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Clarifies release procedure: re-point [Unreleased] compare base and notes release-body newline behavior. |
CHANGELOG.md |
Updates [Unreleased] compare link base from v2.2.0 to v2.3.0. |
.github/workflows/release.yml |
Unwraps hard-wrapped changelog text when generating release-notes.md for GitHub Releases. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
🎭 Visual regression results
Details
Skipped testsmobile-chrome › theme.spec.ts › QuantEcon theme — visual regression › launch-colab |
Two hygiene items from the v2.3.0 cut, one durable fix each:
Release notes rendered with narrow, ragged lines.
CHANGELOG.mdis hard-wrapped (correct for a committed file, where a single newline renders as a space), but GitHub renders release bodies like comments — every newline becomes a line break — so the extracted section showed as a narrow column. The v2.3.0 notes were corrected in place withgh release edit; this PR makesrelease.ymlunwrap the extracted section before publishing, so wrapped changelog source and full-width release notes stop being in tension. Indented continuation lines join their bullet, consecutive>lines join into one blockquote paragraph, and fenced code blocks and nested bullets pass through untouched. Verified locally: the pipeline's output for 2.3.0 is byte-identical to the hand-corrected notes now live on the release.The
[Unreleased]compare link still pointed atv2.2.0...HEAD. Flagged by Copilot on the release-prep PR (chore(release): prepare v2.3.0 #133) — without the re-point, the Unreleased compare includes already-released changes. Nowv2.3.0...HEAD, and the release steps inCONTRIBUTING.mdinclude the re-point so the next cut doesn't repeat the miss.🤖 Generated with Claude Code