Skip to content

release-notes: take the paragraph from the tag object, never a commit #119

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
tinic merged 1 commit into from
Sep 28, 2026
Merged

release-notes: take the paragraph from the tag object, never a commit #119

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ jobs:
# CHANGELOG.md without the version's section.
notes=$(mktemp)
trap 'rm -f "$notes"' EXIT
# checkout leaves the pushed tag pointing at the commit; fetch the
# annotated tag object so its paragraph reaches the notes
git fetch --force origin "+refs/tags/$tag:refs/tags/$tag"
tools/release-notes.sh "$tag" > "$notes"

gh release create "$tag" \
Expand Down
12 changes: 9 additions & 3 deletions tools/release-notes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,15 @@ section=$(awk -v v="## $ver" -v pfx="## ${ver%.*}." '
entries=$(printf '%s\n' "$section" | grep -c '^- ' || true)

# The annotated tag's body, the paragraph written when the release was cut.
# A lightweight tag has none, and the notes do without.
summary=$(git tag -l --format='%(contents:body)' "$tag" 2>/dev/null |
sed '/^-----BEGIN PGP/,$d' | sed -e :a -e '/^\n*$/{$d;N;ba' -e '}')
# A lightweight tag has none, and the notes do without. Read it only from a
# tag object: on a ref to a commit, %(contents:body) is the commit's message,
# and actions/checkout leaves the pushed tag as exactly such a ref, so beta7's
# first notes carried the squash commit's body.
summary=""
if [ "$(git for-each-ref --format='%(objecttype)' "refs/tags/$tag")" = tag ]; then
summary=$(git tag -l --format='%(contents:body)' "$tag" 2>/dev/null |
sed '/^-----BEGIN PGP/,$d' | sed -e :a -e '/^\n*$/{$d;N;ba' -e '}')
fi

# name<TAB>url<TAB>why; a malformed line fails the render rather than
# publishing a broken bullet.
Expand Down
Loading