Skip to content

Release notes list squash-merged pull requests too #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
aakashns merged 1 commit into from
Oct 19, 2026
Merged

Release notes list squash-merged pull requests too #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
31 changes: 22 additions & 9 deletions .github/release-notes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#!/usr/bin/env bash
# Prints the release notes for a version: for each pull request merged since
# the last release, its title, then the full message of each of its commits
# (without the Co-Authored-By lines).
# the last release (with a merge commit or squashed), its title, then the
# full message of each of its commits (without the Co-Authored-By lines).
#
# .github/release-notes.sh 0.15.0 [ref]
#
# `ref` (default HEAD) is what's being released. Needs the tags and the full
# history (actions/checkout with fetch-depth: 0).
# history (actions/checkout with fetch-depth: 0), and fetches squashed pull
# requests' commits from GitHub.
set -euo pipefail

# Commit messages are wrapped at about 72 columns, and GitHub shows every
Expand All @@ -30,14 +31,26 @@ repo=https://github.com/aakashns/writui
prev=$(git describe --tags --abbrev=0 "$ref^" 2>/dev/null || true)

echo "## What's changed"
for merge in $(git rev-list --merges --first-parent --reverse "${prev:+$prev..}$ref"); do
pr=$(git log -1 --format=%s "$merge" | sed -n 's/^Merge pull request #\([0-9]*\) .*/\1/p')
[ -n "$pr" ] || continue
# GitHub puts the pull request's title in the merge commit's body.
title=$(git log -1 --format=%b "$merge" | head -1)
for merge in $(git rev-list --first-parent --reverse "${prev:+$prev..}$ref"); do
subject=$(git log -1 --format=%s "$merge")
pr=$(echo "$subject" | sed -n 's/^Merge pull request #\([0-9]*\) .*/\1/p')
if [ -n "$pr" ]; then
# A merge commit: GitHub puts the pull request's title in its body,
# and its second parent is the pull request's last commit.
title=$(git log -1 --format=%b "$merge" | head -1)
head=$merge^2
else
# A squash merge: "Title (#12)". The pull request's own commits are
# still on GitHub, at pull/12/head.
pr=$(echo "$subject" | sed -n 's/.* (#\([0-9]*\))$/\1/p')
[ -n "$pr" ] || continue
title=${subject% (#"$pr")}
head=refs/writui-notes/pr-$pr
git fetch -q origin "+pull/$pr/head:$head"
fi
echo
echo "### $title ([#$pr]($repo/pull/$pr))"
for commit in $(git rev-list --no-merges --reverse "$merge^1..$merge^2"); do
for commit in $(git rev-list --no-merges --reverse "$merge^1..$head"); do
echo
echo "**$(git log -1 --format=%s "$commit")**"
body=$(git log -1 --format=%b "$commit" | grep -vi '^co-authored-by:' || true)
Expand Down
Loading