Skip to content

Commit e67580c

Browse files
committed
Update release workflow to leverage GitHub's automatic release notes generation
1 parent 2cbce51 commit e67580c

File tree

2 files changed

+7
-46
lines changed

2 files changed

+7
-46
lines changed

.github/RELEASE_TEMPLATE.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
1-
## What's New
2-
<!-- List new features and improvements -->
3-
-
4-
5-
## Bug Fixes
6-
<!-- List fixed issues -->
7-
-
1+
## What's Changed
2+
<!-- This section will be automatically populated by GitHub's release notes generation -->
83

9-
## Security Updates
10-
<!-- List security improvements -->
11-
-
4+
**Full Changelog**: <!-- Will be automatically populated -->
125

136
## 🔐 Security Info
147

.github/workflows/create-release.yml

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,10 @@ jobs:
9797
echo "PREVIOUS_TAG=$previous_tag" >> $GITHUB_OUTPUT
9898
shell: bash
9999

100-
- name: Create enhanced release notes
100+
- name: Create simplified release notes
101101
id: release_notes
102102
run: |
103103
version="${{ steps.get_version.outputs.VERSION }}"
104-
commits="${{ steps.get_commits.outputs.COMMITS }}"
105-
pull_requests="${{ steps.get_commits.outputs.PULL_REQUESTS }}"
106104
current_tag="${GITHUB_REF#refs/tags/}"
107105
108106
# Get the template content
@@ -112,39 +110,9 @@ jobs:
112110
notes="$template_content"
113111
notes="${notes/VERSION/$version}"
114112
115-
# Populate What's New section with PRs
116-
if [ ! -z "$pull_requests" ]; then
117-
# Replace the placeholder in What's New section
118-
notes="${notes/\<!-- List new features and improvements --\>\n- /$pull_requests}"
119-
else
120-
# If no PRs, use commits for What's New
121-
notes="${notes/\<!-- List new features and improvements --\>\n- /$commits}"
122-
fi
123-
124-
# Extract bug fix related commits
125-
bug_fixes=$(echo "$commits" | grep -i "fix\|bug\|issue\|crash\|error" || echo "")
126-
127-
# If we found bug fixes, populate the Bug Fixes section
128-
if [ ! -z "$bug_fixes" ]; then
129-
notes="${notes/\<!-- List fixed issues --\>\n- /$bug_fixes}"
130-
else
131-
# If no bug fixes found, leave a placeholder
132-
notes="${notes/\<!-- List fixed issues --\>\n- /- No specific bug fixes in this release\n}"
133-
fi
134-
135-
# Get previous tag from the get_commits step output
136-
previous_tag="${{ steps.get_commits.outputs.PREVIOUS_TAG }}"
137-
138-
# If previous_tag is empty, use a fallback
139-
if [ -z "$previous_tag" ]; then
140-
# Add a link to the full changelog on GitHub without comparison
141-
changelog_link="\n\n**Full Changelog**: https://github.com/memstechtips/Winhance/commits/$current_tag"
142-
else
143-
# Add a link to the full changelog on GitHub with comparison
144-
changelog_link="\n\n**Full Changelog**: https://github.com/memstechtips/Winhance/compare/$previous_tag...$current_tag"
145-
fi
146-
147-
notes="${notes/## Known Issues/$changelog_link\n\n## Known Issues}"
113+
# Remove the placeholder comments for GitHub's automatic sections
114+
notes="${notes/\<!-- This section will be automatically populated by GitHub's release notes generation --\>/}"
115+
notes="${notes/\<!-- Will be automatically populated --\>/}"
148116
149117
echo "NOTES<<EOF" >> $GITHUB_OUTPUT
150118
echo -e "$notes" >> $GITHUB_OUTPUT

0 commit comments

Comments
 (0)