Changelog and versioning
Turn technical git commits into user-facing changelog entries. This monorepo uses Changesets for versioning and builds the changelog from changeset entries.
When to use
- Preparing release notes for a new version
- Documenting changes for the website or docs pages
- Keeping a consistent writing style across release notes
How it works
- Scan git history for the relevant range.
- Categorize commits (features, improvements, bug fixes, breaking changes) and filter noise (refactor, test, chore).
- Translate developer commits into customer-facing language.
- Format entries per the repo conventions.
References
| Reference | Covers |
|---|---|
| format.md | docs/changelog.md structure, change-type sections, and examples |
Related skills
| Skill | Use for |
|---|---|
| changeset | Writing the changeset a release note comes from |
| documentation | Documentation style for changelog entries |
Checklist
- Code changes have matching documentation updates
- Changeset added via
pnpm changesetfor code changes - Changelog updated in
docs/changelog.md
Resources
- Changesets: https://github.com/changesets/changesets
- VitePress markdown extensions: https://vitepress.dev/guide/markdown