fix: use GitHub username in release changelog instead of git author name #105
Conversation
- Replace %an (git author name) with actual GitHub username via API - Falls back to git author name if API call fails - Ensures @graycreate appears instead of @gray in release notes
There was a problem hiding this comment.
Pull Request Overview
Fixes release changelog generation to use GitHub usernames instead of git author names for proper attribution in release notes.
- Replaces simple git log formatting with GitHub API calls to fetch actual usernames
- Adds fallback mechanism to git author names when API calls fail
- Implements the fix for both scenarios: when a previous tag exists and when generating changelog from recent commits
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
.github/workflows/release.yml
Outdated
| get_github_username() { | ||
| local commit_sha="$1" | ||
| # Try to get the GitHub username from the commit using gh api | ||
| local username=$(gh api "repos/${{ github.repository }}/commits/${commit_sha}" --jq '.author.login // .commit.author.name' 2>/dev/null || echo "") |
There was a problem hiding this comment.
The jq expression .author.login // .commit.author.name will return the commit author name instead of GitHub username when .author.login is null. This defeats the purpose of the API call since .commit.author.name is the same as what the git fallback provides. Consider using .author.login // empty to only return GitHub usernames or nothing.
.github/workflows/release.yml
Outdated
| echo "@$username" | ||
| else | ||
| # Fallback to git author name if API fails | ||
| echo "$(git show -s --format='%an' $commit_sha)" |
There was a problem hiding this comment.
The fallback should be consistent with the original behavior which used @%an format. The fallback is missing the @ prefix that was present in the original implementation.
- Remove unnecessary info text file generation and upload - Keep only the signed APK upload to GitHub release - Simplifies release artifacts
- Use '.author.login // empty' instead of redundant fallback to .commit.author.name - Add @ prefix to git author name fallback for consistency with original format - Ensures cleaner logic flow and consistent @ prefixes in changelog
Summary
Fixes the release changelog to use actual GitHub usernames (@graycreate) instead of git author names (@gray).
Problem
The release workflow was using
%anin git log format, which returns the local git author name ("Gray Zhang") rather than the GitHub username. This caused releases to show incorrect contributor attributions.Solution
Changes
.github/workflows/release.ymlchangelog generation stepTesting
This fix ensures future releases will correctly show:
@graycreateinstead of@Gray🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com