github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-03-11 17:49:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix(release): remove redundant H1 title from generated release notes

Browse Source 
GitHub release UI already displays the title, so including it in the
markdown body creates visual redundancy. Updated generator to start
directly with description paragraph followed by Key Highlights section.

All existing releases (v0.1.0 through v0.4.1) have been updated to
follow this cleaner format.
This commit is contained in:
Vijay Janapa Reddi
2025-11-02 11:28:40 -05:00
parent a0f9e9caec
commit 94dcb6c95d
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tools/scripts/maintenance/changelog-releasenotes.py
View File

@@ -270,9 +270,8 @@ def generate_release_notes_from_changelog(version, previous_version, description
content_improvements.append(item)
# Build the release notes with actual data
release_notes = f"""# Release v{version}: {description}
This release focuses on {'content quality improvements, infrastructure enhancements, and addressing community feedback' if len(content_improvements) > len(infrastructure_changes) else 'infrastructure improvements and content refinements'}.
# Note: Don't include H1 title - GitHub release UI already shows it
release_notes = f"""This release focuses on {'content quality improvements, infrastructure enhancements, and addressing community feedback' if len(content_improvements) > len(infrastructure_changes) else 'infrastructure improvements and content refinements'}.
## 🎯 Key Highlights
"""