Skip to content

Commit 25e2c8c

Browse files
feat(ci): improve release notes with better formatting (#2)
- Use ncipollo/release-action for better release management - Add auto-generated release notes from GitHub - Include links to example configurations - Professional formatting with proper markdown - Remove ugly changelog.txt literal output
1 parent b605237 commit 25e2c8c

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

.github/workflows/helm-release.yaml

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,26 +68,24 @@ jobs:
6868
PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
6969
7070
if [ -z "$PREVIOUS_TAG" ]; then
71-
# First release - get all commits
72-
CHANGELOG=$(git log --pretty=format:"- %s (%h)" --no-merges)
71+
echo "First release - generating full history"
72+
git log --pretty=format:"- %s (%h)" --no-merges > changelog.txt
7373
else
74-
# Get commits since last tag
75-
CHANGELOG=$(git log ${PREVIOUS_TAG}..HEAD --pretty=format:"- %s (%h)" --no-merges)
74+
echo "Generating changelog from ${PREVIOUS_TAG} to HEAD"
75+
git log ${PREVIOUS_TAG}..HEAD --pretty=format:"- %s (%h)" --no-merges > changelog.txt
7676
fi
7777
78-
# Save to file for use in release
79-
echo "$CHANGELOG" > changelog.txt
80-
81-
# Output for GitHub Actions
8278
echo "previous_tag=$PREVIOUS_TAG" >> $GITHUB_OUTPUT
8379
8480
- name: Create GitHub Release
85-
uses: softprops/action-gh-release@v2
81+
uses: ncipollo/release-action@v1
8682
with:
87-
files: |
88-
hub-*.tgz
83+
artifacts: "hub-*.tgz"
84+
bodyFile: ""
8985
body: |
90-
## Helm Chart Release ${{ steps.version.outputs.version }}
86+
## Helm Chart for Formbricks Hub
87+
88+
**Version:** ${{ steps.version.outputs.version }}
9189
9290
### Installation
9391
@@ -101,16 +99,23 @@ jobs:
10199
helm pull oci://ghcr.io/${{ github.repository_owner }}/charts/hub --version ${{ steps.version.outputs.version }}
102100
```
103101
104-
### Changes in this Release
102+
### Configuration
105103
106-
${{ steps.changelog.outputs.previous_tag && format('Changes since {0}:', steps.changelog.outputs.previous_tag) || 'Initial release' }}
104+
See [values.yaml](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/charts/hub/values.yaml) for all configuration options.
105+
106+
Example configurations:
107+
- [Minimal (development)](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/minimal-values.yaml)
108+
- [Production (HA)](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/production-values.yaml)
109+
- [External Database](https://github.com/${{ github.repository }}/blob/v${{ steps.version.outputs.version }}/examples/external-database.yaml)
110+
111+
### Changes in this Release
107112
108-
$(cat changelog.txt)
113+
${{ steps.changelog.outputs.previous_tag != '' && format('**Changes since {0}:**', steps.changelog.outputs.previous_tag) || '**Initial release**' }}
109114
110-
---
111-
**Full Changelog**: https://github.com/${{ github.repository }}/compare/${{ steps.changelog.outputs.previous_tag }}...v${{ steps.version.outputs.version }}
112-
env:
113-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
115+
${{ 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) || '' }}
116+
token: ${{ secrets.GITHUB_TOKEN }}
117+
generateReleaseNotes: true
118+
makeLatest: true
114119

115120
- name: Chart release summary
116121
run: |

0 commit comments

Comments
 (0)