Skip to content

Commit 93d0eb6

Browse files
committed
Remove commit hashes from LLM-generated release notes
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
1 parent 6e669b4 commit 93d0eb6

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

scripts/generate-release-notes.sh

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ Generate release notes following this EXACT template format:
6868
## What's Changed
6969
7070
### New Features
71-
[List new features as bullet points, each starting with "**Feature name**:" followed by description and commit hash in parentheses like (abc123)]
71+
[List new features as bullet points, each starting with "**Feature name**:" followed by description. Do NOT include commit hashes or references.]
7272
7373
### Bug Fixes
74-
[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]
74+
[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.]
7575
7676
### Improvements
77-
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description and commit hash like (abc123)]
77+
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description. Do NOT include commit hashes or references.]
7878
7979
### Breaking Changes
8080
[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 \\
127127
Guidelines:
128128
- Match the exact format and style of the template above
129129
- Use bold for feature/component names followed by colon
130-
- Include commit hashes WITHOUT # symbol - just the hash like (abc123) not (#abc123)
131-
- GitHub will auto-link commit hashes when they appear in parentheses
132-
- For issue references, use # like (#123)
130+
- Do NOT include commit hashes - they clutter the release notes
131+
- Only include issue references like (#123) if explicitly mentioned in commit messages
133132
- Focus on user-visible changes only
134133
- Use clear, non-technical language
135134
- Group related changes together logically

0 commit comments

Comments
 (0)