From 93d0eb6b8a1d886a03fd824c827ce10ca00a1c1b Mon Sep 17 00:00:00 2001 From: rcourtman Date: Tue, 11 Nov 2025 17:11:02 +0000 Subject: [PATCH] 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 --- scripts/generate-release-notes.sh | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/scripts/generate-release-notes.sh b/scripts/generate-release-notes.sh index dbd8388..28c7b33 100755 --- a/scripts/generate-release-notes.sh +++ b/scripts/generate-release-notes.sh @@ -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