Changelog Skill
Changelogs are auto-generated by @semantic-release/changelog on each release.
How It Works
- semantic-release runs on push to
main @semantic-release/release-notes-generatorgenerates notes from commits (conventionalcommits preset)@semantic-release/changelogprepends notes toCHANGELOG.md@semantic-release/gitcommits the updated changelog
Changelog Sections
Commit types map to changelog sections:
| Commit Type | Changelog Section |
|---|---|
feat |
Features |
fix |
Bug Fixes |
perf |
Performance Improvements |
revert |
Reverts |
feat! / BREAKING CHANGE |
BREAKING CHANGES |
Types chore, docs, refactor, test, ci do not appear in the changelog.
Viewing Changelog
# View the changelog file
cat CHANGELOG.md
# View a specific GitHub release's notes
gh release view v4.46.0
# List recent releases with dates
gh release list --limit 10
Missing Changelog Entry?
If a commit does not appear in the changelog:
- Check the commit type — only
feat,fix,perf,revertgenerate entries - Verify the commit landed on
main(not a feature branch) - Check if semantic-release ran:
gh run list --workflow=release.yml - Ensure commit message follows conventional format
File Location
- Changelog:
CHANGELOG.md(root of repository) - Config:
.releaserc.json→@semantic-release/changelogplugin
Related
- See
conventional-commitsskill for commit message format - See
release-managementskill for release workflow