/release-notes - Release Notes Generator
Generate complete, customer-facing release notes from merged pull requests. Categorizes changes, highlights breaking changes, includes migration instructions, and links to relevant PRs.
System Prompt
EXECUTION DIRECTIVE: When the user invokes this command, you MUST:
- IMMEDIATELY execute - no questions first
- Load the agent
release-notes-generator - Determine range from last release tag to HEAD (or specified range)
- Collect merged PRs via GitHub API
- Categorize each PR (Features, Fixes, Breaking, Security, etc.)
- Extract breaking change details and migration instructions from PR bodies
- Format customer-facing release notes
- Output structured release notes markdown
Usage
# Default: since last release tag
/release-notes
# Specific version
/release-notes --version 2.3.0
# From specific tag
/release-notes --since-tag v2.2.0
# Include internal changes
/release-notes --include-internal
# Create GitHub release draft
/release-notes --publish
# JSON output
/release-notes --format json
Options
| Option | Description | Default |
|---|---|---|
--version | Version number for release | auto-detect |
--since-tag | Start from this tag | latest release |
--until | End reference | HEAD |
--include-internal | Include chore/refactor PRs | false |
--format | Output format (markdown, json) | markdown |
--publish | Create GitHub release draft | false |
Related Commands
/changelog- Maintain CHANGELOG.md (developer-facing)/release-gate- Verify release readiness before generating notes/weekly-digest- Broader weekly activity summary/breaking-impact- Detailed breaking change analysis
Success Output
COMMAND COMPLETE: /release-notes
Version: v2.3.0
PRs Included: 23
Categories: 8 features, 12 fixes, 2 breaking, 1 security
Contributors: 5
Breaking Changes: 2 (migration instructions included)
Completion Checklist
- Release range determined
- All merged PRs collected
- PRs categorized
- Breaking changes documented with migration
- Contributors credited
- Links validated
Failure Indicators
- GitHub API unreachable
- No merged PRs in range
- Missing release tags
- Breaking PR without migration section in body
When NOT to Use
- Developer changelog (use
/changelog) - Weekly summary (use
/weekly-digest) - Single PR description (use
/describe-pr)
Anti-Patterns
| Anti-Pattern | Problem | Solution |
|---|---|---|
| Raw PR titles | Unclear to customers | Rewrite in customer language |
| Skip breaking docs | Upgrade failures | Require migration section |
| Include internal PRs | Noise | Filter by label |
Principles
- #3 Complete Execution - Every PR categorized and linked
- #6 Clear, Understandable - Customer-facing language
Full Standard: CODITECT-STANDARD-AUTOMATION.md