Skip to content

ci: fix release notes generation#2

Merged
ds17f merged 1 commit into
mainfrom
fix/release-notes
Jun 3, 2026
Merged

ci: fix release notes generation#2
ds17f merged 1 commit into
mainfrom
fix/release-notes

Conversation

@ds17f
Copy link
Copy Markdown
Owner

@ds17f ds17f commented Jun 3, 2026

Release notes were coming out wrong because the changelog round-tripped through the git tag message, and git strips #-prefixed lines (our Markdown headings) from tag messages by default.

Fix: scripts/release.sh --notes <tag> prints clean Conventional-Commit notes from git log; release.yml uses it via --notes-file. No dependence on the tag message. Tag creation also uses --cleanup=verbatim.

Already retroactively fixed the published v0.1.0 notes.

🤖 Generated with Claude Code

git's default tag-message cleanup strips lines starting with '#', which
deleted the Markdown '##'/'###' headings from the changelog, and reading
the annotated tag on the runner was unreliable. release.sh now has a
`--notes <tag>` mode that prints clean Conventional-Commit notes from git
log; release.yml uses it via --notes-file. Tag creation also uses
--cleanup=verbatim so stored tag messages keep their headings.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ds17f ds17f merged commit 94d53b6 into main Jun 3, 2026
1 check passed
@ds17f ds17f deleted the fix/release-notes branch June 3, 2026 15:57
ds17f added a commit that referenced this pull request Jun 5, 2026
git's default tag-message cleanup strips lines starting with '#', which
deleted the Markdown '##'/'###' headings from the changelog, and reading
the annotated tag on the runner was unreliable. release.sh now has a
`--notes <tag>` mode that prints clean Conventional-Commit notes from git
log; release.yml uses it via --notes-file. Tag creation also uses
--cleanup=verbatim so stored tag messages keep their headings.

Co-authored-by: Damian Silbergleith <14797221+ds17f@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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