Skip to content

Commit fe062de

Browse files
lostindarkCopilot
andcommitted
fix: make highlights more concise, add changelog link, fix author attribution
- Keep descriptions to one sentence per item - Use PR author (not commit author) for attribution - Add Full Changelog comparison link at the end Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d24b8ed commit fe062de

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

.github/workflows/release-highlights.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Use the GitHub MCP tools to fetch release information for `${{ github.repository
3232

3333
2. **Get all commits between releases** — Use `list_commits` or `git log <prev_tag>..${{ inputs.version }} --oneline` via shell to get all commits between the previous published release tag and `${{ inputs.version }}`.
3434

35-
3. **Optionally get merged PRs** — Search for merged pull requests if needed for additional context, but rely primarily on commits since not all changes go through PRs. Use the default branch (`master`), not `main`.
35+
3. **Get merged PRs** — Search for merged pull requests in the repository on the `master` branch between the two releases. Use the PR author and PR number for attribution in the highlights. Not all commits have PRs, but always check.
3636

3737
**IMPORTANT**: Compare against the last **published** release (e.g., v0.12.152), NOT the immediately previous tag. Many tags may be CI/infrastructure-only.
3838

@@ -42,7 +42,7 @@ Group changes by category (omit categories with no items):
4242
- **⚠️ Breaking Changes** - Requires user action (ALWAYS list first if present)
4343
- **✨ New Features** - User-facing capabilities
4444
- **🐛 Bug Fixes** - Issue resolutions
45-
- **⚡ Performance** - Speed/efficiency improvements
45+
- **🌐 Localization** - New or updated translations
4646
- **🔧 Internal** - Refactoring, dependencies (usually omit from highlights)
4747

4848
Use both commit messages and PR titles to determine categories.
@@ -60,20 +60,24 @@ Structure:
6060
[If any - list FIRST with migration guidance]
6161

6262
### ✨ What's New
63-
[Key features with user benefit — include author and PR link]
63+
- **Feature name** — short description. (#PR by @author)
6464

6565
### 🐛 Bug Fixes & Improvements
66-
[Notable fixes — include author and PR link]
66+
- **Fix name** — short description. (#PR by @author)
67+
68+
### 🌐 Localization
69+
- Updated translations for [languages]. (#PR by @author)
70+
71+
**Full Changelog**: https://github.com/${{ github.repository }}/compare/<prev_tag>...${{ inputs.version }}
6772
```
6873

6974
**Writing Guidelines:**
70-
- Lead with benefits: "Driver deletion is now 2x faster" not "Optimized delete loop"
71-
- Be specific about what changed and why it matters to users
72-
- Keep it concise and scannable (users grasp key changes in 30 seconds)
73-
- Use professional, enthusiastic tone
75+
- Keep descriptions short and concise — one sentence per item
76+
- Be specific about what changed, but don't over-explain
77+
- For each item, include the PR number and the **actual PR author** (check the PR data, not the commit author — they may differ)
78+
- If a change has multiple PRs, list all PR numbers: `(#42 #43 by @author)`
79+
- End with a Full Changelog link comparing the previous published release tag to `${{ inputs.version }}`
7480
- This is a Windows desktop application — write from the end-user perspective
75-
- For each item, include the author and PR reference at the end, e.g.:
76-
`- **In-place self-update** — description. (#42 by @username)`
7781

7882
### 4. Handle Special Cases
7983

0 commit comments

Comments
 (0)