By name: changeset description: Add a changeset file for a package version bump user_invocable: true
Add Changeset
Create a changeset file in .changeset/ for the specified package(s).
Format
---
'package-name': patch|minor|major
---
First line is a high-level summary without leading dash (PR number gets appended automatically).
- Additional detail line.
- Another detail line.
- **Breaking change**: Description of what breaks.
Rules
- First line: Write as a plain sentence, no leading dash. The release tooling appends the PR link to this line.
- Subsequent lines: Start each line with a dash. These lines get 2 spaces prepended automatically during the release process, so they appear indented under the first line in CHANGELOG.md.
- Breaking changes: Mark with Breaking change or Breaking changes (see format example above).
- File naming: Use a short kebab-case description, e.g.,
add-cli-package.md,move-schemas-to-common.md. - Multiple packages: Multiple packages can share a changeset file with different bump levels in the frontmatter. Use separate files only when packages need unrelated descriptions.
- Bump levels: Follow semver based on current package version.
x.y.z(>=1.0.0): major for breaking, minor for features, patch for fixes.0.x.y: minor for breaking, patch for features/fixes.0.0.x: patch for everything. - New unpublished packages: Still need a changeset to bump the initial version in package.json and for the changes to appear in the resulting changelog.
Steps
- Determine which packages changed and what bump level each needs.
- Review existing CHANGELOG.md for the package(s) to match tone and style.
- Write the changeset file(s) to
.changeset/<descriptive-name>.md.