Skip to content

Guard the changelog entry, not the composed release note #33

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeliriumPulse merged 1 commit into from
Aug 7, 2026
Merged

Guard the changelog entry, not the composed release note #33

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
27 changes: 16 additions & 11 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,23 @@ jobs:
# commit subjects. `--generate-notes` on a repo whose only commit per
# release is "Release CodeTruss CLI vX" produces a note that says
# nothing a reader did not already know from the title.
{
awk -v ver="## $VERSION " '
index($0, ver) == 1 { found = 1; next }
found && /^## / { exit }
found { print }
' CHANGELOG.md
awk -v ver="## $VERSION " '
index($0, ver) == 1 { found = 1; next }
found && /^## / { exit }
found { print }
' CHANGELOG.md > changelog-entry.md

# Guard the EXTRACTED ENTRY, not the composed file. The install section
# below is written unconditionally, so a check after composition can
# never fail, and a version missing its changelog entry would publish a
# release note containing nothing but install steps.
if [ ! -s changelog-entry.md ]; then
echo "No changelog entry found for $VERSION; refusing to publish an empty release note." >&2
exit 1
fi

{
cat changelog-entry.md
cat <<NOTES

## Install
Expand Down Expand Up @@ -118,11 +128,6 @@ jobs:
NOTES
} > release-notes.md

if [ ! -s release-notes.md ]; then
echo "No changelog entry found for $VERSION; refusing to publish an empty release note." >&2
exit 1
fi

gh release create "$GITHUB_REF_NAME" \
--draft \
--verify-tag \
Expand Down