Skip to content

chore(release): credit commit authors in the changelog #295

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

chore(release): credit commit authors in the changelog #295

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
30 changes: 30 additions & 0 deletions .github/scripts/credit-authors.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#!/usr/bin/env bash
# Append " by <author>" to every changelog entry for a commit in <base>...<head>.
# Credited entries no longer end in a commit link, so re-running is a no-op.
# Usage: credit-authors.sh <base> <head> <file>... (needs GH_TOKEN, GH_REPO)
set -euo pipefail

base=$1
head=$2
shift 2

# Raw "<sha> <author>" lines, not @tsv: a name is taken verbatim, escapes and
# all, and a Git author name can hold no newline to break the format.
authors=$(mktemp)
gh api --paginate "repos/$GH_REPO/compare/$base...$head" \
--jq '.commits[]
| .sha + " " + (if .author.login then "@" + .author.login else .commit.author.name end)' \
> "$authors"

for file in "$@"; do
awk '
NR == FNR { author[$1] = substr($0, index($0, " ") + 1); next }
{
if (match($0, /\/commit\/[0-9a-f]+\)\)$/)) {
sha = substr($0, RSTART + 8, RLENGTH - 10)
if (sha in author) $0 = $0 " by " author[sha]
}
print
}' "$authors" "$file" > "$file.credited"
mv "$file.credited" "$file"
done
Comment thread
narnaud marked this conversation as resolved.
56 changes: 39 additions & 17 deletions .github/workflows/release-please.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,58 @@ jobs:
name: Release Please
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
Comment thread
narnaud marked this conversation as resolved.
with:
token: ${{ secrets.RELEASE_TOKEN }}
- uses: googleapis/release-please-action@v5
id: release
with:
token: ${{ secrets.RELEASE_TOKEN }}
# The release notes come from the pull request body, so they need the
# same credits applied separately from the changelog.
- name: Credit commit authors in the release notes
if: ${{ steps.release.outputs.release_created == 'true' }}
shell: bash
env:
GH_TOKEN: ${{ secrets.RELEASE_TOKEN }}
REPO: ${{ github.repository }}
GH_REPO: ${{ github.repository }}
TAG: ${{ steps.release.outputs.tag_name }}
run: |
previous=$(gh api "repos/$REPO/releases?per_page=10" \
previous=$(gh api "repos/$GH_REPO/releases?per_page=10" \
--jq 'map(select(.draft | not)) | map(select(.tag_name != env.TAG)) | .[0].tag_name // empty')
if [ -z "$previous" ]; then
echo "No previous release to compare against, skipping."
exit 0
fi
gh api --paginate "repos/$REPO/compare/$previous...$TAG" \
--jq '.commits[]
| [.sha, (if .author.login then "@" + .author.login else .commit.author.name end)]
| @tsv' > authors.tsv
gh release view "$TAG" --repo "$REPO" --json body --jq .body > notes.md
awk -F'\t' '
NR == FNR { author[$1] = $2; next }
{
if (match($0, /\/commit\/[0-9a-f]+\)\)$/)) {
sha = substr($0, RSTART + 8, RLENGTH - 10)
if (sha in author) $0 = $0 " by " author[sha]
}
print
}' authors.tsv notes.md > credited.md
gh release edit "$TAG" --repo "$REPO" --notes-file credited.md
gh release view "$TAG" --json body --jq .body > notes.md
bash .github/scripts/credit-authors.sh "$previous" "$TAG" notes.md
gh release edit "$TAG" --notes-file notes.md
# Credit on the release branch, not on main: the changelog is then
# already credited at the tag. release-please force-pushes the branch on
# every run, so this reapplies the credits each time.
- name: Credit commit authors in the changelog
if: ${{ steps.release.outputs.pr }}
shell: bash
env:
GH_TOKEN: ${{ secrets.RELEASE_TOKEN }}
GH_REPO: ${{ github.repository }}
BRANCH: ${{ fromJSON(steps.release.outputs.pr).headBranchName }}
HEAD_SHA: ${{ github.sha }}
run: |
previous=$(gh api "repos/$GH_REPO/releases?per_page=10" \
--jq 'map(select(.draft | not)) | .[0].tag_name // empty')
if [ -z "$previous" ]; then
echo "No previous release to compare against, skipping."
exit 0
fi
git fetch origin "+refs/heads/$BRANCH:refs/remotes/origin/$BRANCH"
git checkout -B "$BRANCH" "refs/remotes/origin/$BRANCH"
bash .github/scripts/credit-authors.sh "$previous" "$HEAD_SHA" CHANGELOG.md
if git diff --quiet; then
echo "Authors already credited."
exit 0
fi
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git commit -am "chore(release): credit commit authors in the changelog"
git push origin "$BRANCH"
Loading