changelog-generator
Helpful guide on how to generate and structure a changelog for app releases.
When & Why to Use This Skill
The Changelog Generator is a specialized Claude skill designed to automate the creation of structured, developer-friendly release notes from Git history. It streamlines the documentation process by analyzing commit logs, grouping changes by type (Added, Fixed, Changed, Removed), and highlighting breaking changes with code samples. This tool ensures that software releases are accompanied by clear, professional, and consistent documentation, improving communication between development teams and users.
Use Cases
- Preparing official release notes by extracting and summarizing meaningful commits since the last version tag.
- Documenting breaking API changes with side-by-side code examples to assist developers with migration and upgrades.
- Standardizing the changelog format across multiple repositories to maintain a consistent project history and style guide.
- Generating internal version notes to track feature progress and bug fixes across different development milestones or branches.
| name | changelog-generator |
|---|---|
| description | Generate structured changelogs for app releases from git history. Use when preparing releases, documenting changes, or creating version notes. |
| allowed-tools | Read, Bash(git:*) |
Changelog Generator
Generate clean, developer-friendly changelogs from git history with code samples for breaking changes.
When to Use
- Preparing a new release
- Documenting changes since last version
- Creating release notes
- Reviewing what changed between tags
Instructions
Step 1: Determine Version Range
# Find the last release tag
git describe --tags --abbrev=0
# List recent tags for reference
git tag --sort=-version:refname | head -5
Step 2: Gather Commits
# Get commits since last tag
git log $(git describe --tags --abbrev=0)..HEAD --oneline --no-merges
Step 3: Generate Changelog
Create .changelogs/{version}.md with:
- Simple checklist format - one item per meaningful change
- No unnecessary comments - keep it scannable
- Code samples for breaking/API changes - brief, compliant examples
Output Format
# v{version}
## Changes
- [ ] Added: Feature description
- [ ] Fixed: Bug description
- [ ] Changed: Behavior change description
- [ ] Removed: Deprecated item
## Breaking Changes
### Change Title
Brief description of what changed.
```ts
// Before
oldMethod(param: string)
// After
newMethod(param: string, options?: Options)
Migration Notes
[Only if applicable - brief migration steps]
## Guidelines
- **Group by type**: Added, Fixed, Changed, Removed, Deprecated
- **Be concise**: One line per change, details only when needed
- **Code samples**: Only for developer-facing changes that need examples
- **Language tags**: Always include language in code blocks (e.g., `ts`, `js`, `bash`)
## Example
**Input**: Generate changelog for v2.1.0
**Output**: `.changelogs/v2.1.0.md`
```markdown
# v2.1.0
## Changes
- [x] Added: WebSocket reconnection with exponential backoff
- [x] Fixed: Memory leak in event listener cleanup
- [x] Changed: Default timeout from 30s to 60s
## Breaking Changes
### Event handler signature updated
```ts
// Before
client.on('message', (data) => {})
// After
client.on('message', (data, metadata) => {})
## Notes
- Infer version from context or prompt user if unclear
- Skip merge commits and version bump commits
- Focus on user/developer-facing changes