danvics/Pulse
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove commit hashes from LLM-generated release notes

Browse source 
Commit hashes clutter the release notes and aren't useful for end users.
Only include issue references when explicitly mentioned in commits.

Related to #671
This commit is contained in:
rcourtman 2025-11-11 17:11:02 +00:00
parent 6e669b46dc
commit 93d0eb6b8a
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
scripts/generate-release-notes.sh
View file

@ -68,13 +68,13 @@ Generate release notes following this EXACT template format:
## What's Changed
### New Features
[List new features as bullet points, each starting with "**Feature name**:" followed by description and commit hash in parentheses like (abc123)]
[List new features as bullet points, each starting with "**Feature name**:" followed by description. Do NOT include commit hashes or references.]
### Bug Fixes
[List bug fixes as bullet points, each starting with "**Component/area**:" followed by description and issue/commit reference like (#123) for issues or (abc123) for commits]
[List bug fixes as bullet points, each starting with "**Component/area**:" followed by description. Include issue references like (#123) ONLY if the commit message explicitly mentions an issue number. Do NOT include commit hashes.]
### Improvements
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description and commit hash like (abc123)]
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description. Do NOT include commit hashes or references.]
### Breaking Changes
[List any breaking changes, or write "None" if there are none]
@ -127,9 +127,8 @@ helm upgrade --install pulse oci://ghcr.io/rcourtman/pulse-chart \\
Guidelines:
- Match the exact format and style of the template above
- Use bold for feature/component names followed by colon
- Include commit hashes WITHOUT # symbol - just the hash like (abc123) not (#abc123)
- GitHub will auto-link commit hashes when they appear in parentheses
- For issue references, use # like (#123)
- Do NOT include commit hashes - they clutter the release notes
- Only include issue references like (#123) if explicitly mentioned in commit messages
- Focus on user-visible changes only
- Use clear, non-technical language
- Group related changes together logically