Skip to content

feat(ci): enhance release notes with issue tracking#77

Merged
CalvinAllen merged 3 commits into
mainfrom
feat/76-release-notes-enhancement
Dec 10, 2025
Merged

feat(ci): enhance release notes with issue tracking#77
CalvinAllen merged 3 commits into
mainfrom
feat/76-release-notes-enhancement

Conversation

@CalvinAllen

@CalvinAllen CalvinAllen commented Dec 10, 2025

Copy link
Copy Markdown
Contributor

Summary

  • Enhance release workflow to generate meaningful release notes by tracing commits → PRs → issues
  • Add /release-note comment support for custom highlight messages on issues
  • Create preview changelog workflow for on-demand testing before releases
  • Extract changelog generation to reusable workflow to avoid duplication

Release Note Structure

## What's New in vX.Y.Z

### ✨ Highlights
- Custom message from /release-note comment on issue #72
- Custom message from /release-note comment on issue #74

### 📋 Closed Issues
- #59 - fix(shim): Windows shim exit code handling
- #72 - perf(shim): optimize shim startup time and binary size
- #74 - refactor(shim): implement lite provider interface

Usage

Add a /release-note comment to any issue before releasing:

/release-note Shim binary is now 56% smaller with faster startup

Preview release notes anytime via Actions → "Preview Changelog" → "Run workflow"

Test plan

  • Run "Preview Changelog" workflow to verify changelog generation
  • Verify issues with /release-note comments appear in Highlights section
  • Verify all closed issues appear in Closed Issues section
  • Create a test release to verify full workflow integration

Fixes #76

@CalvinAllen
feat(ci): enhance release notes with issue tracking
55d0741 
- Trace commits to PRs to issues for accurate changelog
- Add /release-note comment parsing for custom highlights
- New release notes structure with Highlights and Closed Issues sections
- Change header to "What's New in vX.Y.Z"

Fixes #76
@CalvinAllen
feat(ci): add preview changelog workflow
cb56146 
Allows running the changelog generation on-demand to preview
release notes before creating an actual release.
@CalvinAllen
refactor(ci): extract changelog generation to reusable workflow
c552e74 
- Create generate-changelog.yml as reusable workflow
- Update release.yml to use the reusable workflow
- Simplify preview-changelog.yml to use the reusable workflow
@CalvinAllen CalvinAllen changed the title feat(ci): enhance release notes with issue tracking and custom highlights feat(ci): enhance release notes with issue tracking Dec 10, 2025
@CalvinAllen CalvinAllen merged commit 0b8ebf0 into main Dec 10, 2025
10 of 11 checks passed
@CalvinAllen CalvinAllen deleted the feat/76-release-notes-enhancement branch December 10, 2025 20:38
@CalvinAllen

CalvinAllen commented Dec 10, 2025

Copy link
Copy Markdown
Contributor Author

/skip-changelog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feat(ci): enhance release notes with issue tracking and custom highlights

1 participant

@CalvinAllen