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

Fix commit hash linking in release notes

Browse source 
Remove # symbol from commit hash references so GitHub auto-links them.
Format: (abc123) instead of (#abc123)
Issue references still use #: (#123)

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

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

@ -68,13 +68,13 @@ Generate release notes following this EXACT template format:
## What's Changed ## What's Changed
### New Features ### 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 and commit hash in parentheses like (abc123)]
### Bug Fixes ### Bug Fixes
[List bug fixes as bullet points, each starting with "**Component/area**:" followed by description and issue/commit reference like (#123) or (#abc123)] [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]
### Improvements ### Improvements
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description] [List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description and commit hash like (abc123)]
### Breaking Changes ### Breaking Changes
[List any breaking changes, or write "None" if there are none] [List any breaking changes, or write "None" if there are none]
@ -127,7 +127,9 @@ helm upgrade --install pulse oci://ghcr.io/rcourtman/pulse-chart \\
Guidelines: Guidelines:
- Match the exact format and style of the template above - Match the exact format and style of the template above
- Use bold for feature/component names followed by colon - Use bold for feature/component names followed by colon
- Include commit hashes in parentheses like (#abc123) or issue numbers like (#123) - 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)
- Focus on user-visible changes only - Focus on user-visible changes only
- Use clear, non-technical language - Use clear, non-technical language
- Group related changes together logically - Group related changes together logically