release-notes-generator
Automate release note generation from git commits. Categorizes changes, transforms technical jargon into user-friendly summaries, and supports CHANGELOG.md, PR bodies, and Slack announcements.
Introduction
The Release Notes Generator is a powerful automation skill designed to streamline the software delivery process by transforming raw git commit history into structured, meaningful documentation. It is specifically tailored for development teams who want to maintain high-quality communication with stakeholders, product managers, and end-users without the manual burden of writing release logs. By integrating directly with your git workflow and GitHub API, the tool intelligently analyzes the history since your last release tag, categorizes changes into features, bug fixes, performance improvements, and security patches, and then distills this information into three distinct formats: technical CHANGELOG.md files, semi-technical Pull Request bodies, and user-friendly Slack announcements.
-
Automatically categorizes changes using conventional commit prefixes (feat, fix, perf, security, etc.)
-
Performs automated translation of technical jargon (e.g., 'N+1 query optimization' to 'Faster list loading') for non-technical stakeholders
-
Detects database migrations via git diff on migration directories and generates critical alerts in the console output
-
Fetches enriched data like PR titles, descriptions, and labels via gh api for better context
-
Produces consistent output across multiple channels to ensure alignment between developers and product teams
-
Supports configurable templates for Slack announcements and PR release templates
-
Run the skill from the repository root to generate notes since the last git tag or specific version ranges
-
Requires an authenticated GitHub CLI (gh) setup to access PR metadata
-
Recommended to use with standard conventional commit patterns for optimal categorization accuracy
-
Provides a dry-run/preview mode to verify output before files are written to the disk
-
Always review generated content to ensure tone accuracy before broadcasting to public channels
-
Handles complex output logic including statistics aggregation (number of PRs, features, and bugs per release)
Repository Stats
- Stars
- 4,082
- Forks
- 537
- Open Issues
- 5
- Language
- TypeScript
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- May 1, 2026, 07:53 AM