fix(release): tidy up auto-generated changelog items#195
Merged
Conversation
Three small cleanups in scripts/update-repo-changelog.js after seeing how the v3.0.0 changelog rendered: - Render scope as a parenthesised qualifier on the prefix (e.g. "Fix (documentation): add ngram-index...") instead of the awkward double-colon "Fix: documentation: add ngram-index..." - Collapse hard-wrapped newlines from commit bodies into single spaces so a BREAKING CHANGE footer doesn't render with a line break in the middle of the sentence inside an <li> - Strip backslash-escapes that immediately precede backticks. Commit bodies authored via shell heredocs sometimes carry literal `\`` pairs that are meaningless once the text lands in an HTML list item Closes #TBD-followup-of-v3.0.0-release
joewiz
force-pushed
the
fix/changelog-formatting
branch
from
ca1b722 to
a3fe260
Compare
line-o
approved these changes
May 28, 2026
|
🎉 This PR is included in version 3.0.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[This PR was co-authored with Claude Code. -Joe]
Three cosmetic bugs surfaced in v3.0.0's bundled
repo.xmlchangelog (visible to users browsing the package's Changelog tab in Dashboard > Package Manager):fix(documentation): add ngram-index...came out asFix: documentation: add ngram-index...(double colon, repeated noise). Now:Fix (documentation): add ngram-index....BREAKING CHANGE:footer split across two source lines rendered with a literal newline inside the<li>. Now collapsed to a single space.\`pairs from<<'EOF'heredoc handling; stripped now since they're meaningless once they reach HTML.Verified by re-running
update-repo-changelog.js --version=3.0.1 --prev-tag=2.1.1against the actual v3.0.0..master commit history; the generated<change version="3.0.1">entry now reads cleanly:(
&&is the XML-escaped form; the in-app changelog renders it as the literal&&.)When this merges, semantic-release will tag v3.0.1 (the
fix:prefix triggers a patch bump). Since master already has the README update from #192, v3.0.1's.xarwill pick that up automatically — bundled changelog and bundled README will both be current, ready to publish to exist-db.org public-repo.