What problem does it solve?
Writing consistent, user-facing release highlights for each version is repetitive and error-prone, especially when the same summary must stay identical across the Changelog and the GitHub Release page.
Core Features & Use Cases
- Draft from Changelog: Reads the target version's full Changelog as the factual boundary, tracing related issues or commits only when entries are unclear, and condenses user-visible changes into a few outcome-oriented themes.
- Approval-gated sync: Presents the draft for explicit user confirmation before touching anything, keeping the Changelog and GitHub Release read-only until approved.
- Atomic publish: Inserts the confirmed block into the Changelog, mirrors it verbatim to the GitHub Release, commits with
chore(changelog): add <version> highlights, and pushes to main.
- Use Case: After tagging v1.4.0, ask the assistant to draft the release highlights; review the proposed themes, approve them, and have the Changelog, GitHub Release, and git push completed in one flow.
Quick Start
Use add-release-highlights to draft the highlights for version 1.4.0, wait for my approval, then sync them to the Changelog and GitHub Release and push to main.
