Skip to content

fix(release): strip Docusaurus front matter from GitHub Release notes #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haksungjang merged 1 commit into from
Jul 6, 2026
Merged

fix(release): strip Docusaurus front matter from GitHub Release notes #473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,17 @@ jobs:
NOTES_FILE="docs-site/docs/release-notes/${TAG}.md"
if [ -f "$NOTES_FILE" ]; then
echo "using curated release notes: $NOTES_FILE"
gh release create "$TAG" --draft --title "$TAG" --notes-file "$NOTES_FILE"
# Strip the Docusaurus YAML front matter (the leading --- ... ---
# block). GitHub renders the Release body as plain Markdown and does
# NOT recognise front matter — worse, the closing `---` is parsed as
# the setext-heading underline of the metadata block above it, so the
# whole `id:/title:/description:/...` block renders as one giant H2.
# Emit only the body after the second `---` delimiter.
BODY_FILE="${RUNNER_TEMP}/${TAG}-notes.md"
awk 'NR==1 && $0=="---" {infm=1; next}
infm && $0=="---" {infm=0; next}
!infm {print}' "$NOTES_FILE" > "$BODY_FILE"
gh release create "$TAG" --draft --title "$TAG" --notes-file "$BODY_FILE"
else
echo "no curated notes for $TAG — auto-generating from history"
gh release create "$TAG" --draft --title "$TAG" --generate-notes
Expand Down
Loading