Skip to content

feat(ci): improve release notes with better formatting #2

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
BhagyaAmarasinghe merged 1 commit into from
Oct 29, 2025
Merged

feat(ci): improve release notes with better formatting #2

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
43 changes: 24 additions & 19 deletions .github/workflows/helm-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,26 +68,24 @@ jobs:
PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")

if [ -z "$PREVIOUS_TAG" ]; then
# First release - get all commits
CHANGELOG=$(git log --pretty=format:"- %s (%h)" --no-merges)
echo "First release - generating full history"
git log --pretty=format:"- %s (%h)" --no-merges > changelog.txt
else
# Get commits since last tag
CHANGELOG=$(git log ${PREVIOUS_TAG}..HEAD --pretty=format:"- %s (%h)" --no-merges)
echo "Generating changelog from ${PREVIOUS_TAG} to HEAD"
git log ${PREVIOUS_TAG}..HEAD --pretty=format:"- %s (%h)" --no-merges > changelog.txt
fi

# Save to file for use in release
echo "$CHANGELOG" > changelog.txt

# Output for GitHub Actions
echo "previous_tag=$PREVIOUS_TAG" >> $GITHUB_OUTPUT

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
uses: ncipollo/release-action@v1
with:
files: |
hub-*.tgz
artifacts: "hub-*.tgz"
bodyFile: ""
body: |
## Helm Chart Release ${{ steps.version.outputs.version }}
## Helm Chart for Formbricks Hub

**Version:** ${{ steps.version.outputs.version }}

### Installation

Expand All @@ -101,16 +99,23 @@ jobs:
helm pull oci://ghcr.io/${{ github.repository_owner }}/charts/hub --version ${{ steps.version.outputs.version }}
```

### Changes in this Release
### Configuration

${{ steps.changelog.outputs.previous_tag && format('Changes since {0}:', steps.changelog.outputs.previous_tag) || 'Initial release' }}
See [values.yaml](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/charts/hub/values.yaml) for all configuration options.

Example configurations:
- [Minimal (development)](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/minimal-values.yaml)
- [Production (HA)](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/production-values.yaml)
- [External Database](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/external-database.yaml)

### Changes in this Release

$(cat changelog.txt)
${{ steps.changelog.outputs.previous_tag != '' && format('**Changes since {0}:**', steps.changelog.outputs.previous_tag) || '**Initial release**' }}

---
**Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ steps.changelog.outputs.previous_tag }}...v${{ steps.version.outputs.version }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
${{ steps.changelog.outputs.previous_tag != '' && format('[View full diff]({0}/compare/{1}...v{2})', github.server_url, steps.changelog.outputs.previous_tag, steps.version.outputs.version) || '' }}
token: ${{ secrets.GITHUB_TOKEN }}
generateReleaseNotes: true
makeLatest: true

- name: Chart release summary
run: |
Expand Down