Skip to content

chore: Improve changelog generation in the release workflow #12

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
bnimit merged 1 commit into from
Dec 10, 2025
Merged

chore: Improve changelog generation in the release workflow #12

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
48 changes: 43 additions & 5 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,54 @@ jobs:
COMMIT_RANGE=$LATEST_TAG..HEAD
fi

# Generate changelog
CHANGELOG=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges)

# Save to file for PR body
# Generate categorized changelog
FEATURES=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges --grep="^feat" || echo "")
FIXES=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges --grep="^fix" || echo "")
CHORE=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges --grep="^chore" || echo "")
DOCS=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges --grep="^docs" || echo "")
OTHER=$(git log $COMMIT_RANGE --pretty=format:"- %s (%h)" --no-merges --invert-grep --grep="^feat\|^fix\|^chore\|^docs" || echo "")

# Build changelog with sections
cat > /tmp/changelog.md <<EOF
## Changes in v${{ steps.bump_version.outputs.new_version }}

$CHANGELOG
EOF

if [ -n "$FEATURES" ]; then
echo "### ✨ Features" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
echo "$FEATURES" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
fi

if [ -n "$FIXES" ]; then
echo "### 🐛 Bug Fixes" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
echo "$FIXES" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
fi

if [ -n "$CHORE" ]; then
echo "### 🔧 Chore" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
echo "$CHORE" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
fi

if [ -n "$DOCS" ]; then
echo "### 📚 Documentation" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
echo "$DOCS" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
fi

if [ -n "$OTHER" ]; then
echo "### 🔨 Other Changes" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
echo "$OTHER" >> /tmp/changelog.md
echo "" >> /tmp/changelog.md
fi

# Output for use in PR
echo "changelog<<EOF" >> $GITHUB_OUTPUT
cat /tmp/changelog.md >> $GITHUB_OUTPUT
Expand Down