Changesets
Changesets records user-visible changes as small markdown files under .changeset/. At release time they drive version bumps and CHANGELOG.md.
TL;DR
| You did… | You do… |
|---|---|
| Made a user-visible change | pnpm changeset → pick bump → write summary → commit the file |
| Touched only tests, docs, CI, internal refactor | No changeset. Add skip-changeset PR label if CI complains |
Never edit package.json version or CHANGELOG.md by hand. Never run changeset version or changeset publish yourself.
Bump types
| Bump | When to use |
|---|---|
| patch | Bug fix, internal refactor with consumer-visible note |
| minor | New component, prop, slot, emit, export — backwards compatible |
| major | Breaking change — removed export, changed default, migration required |
Anatomy
md
---
'vetro-ui': minor
---
Button: add `loading` prop that shows a spinner and disables clicks.Maintainer release flow
- Merge feature PRs to
main(each with a changeset when user-visible). - Bump
package.jsonversion (manually, or via Actions → Release which runschangeset version, commitschore(release): vX.Y.Z, and tags). - Every push to
mainruns Publish. If that version is not yet on npm: build,npm publish, optional webc CDN, GitHub Release. If already published, the workflow skips cleanly.
You can also run Publish manually via workflow_dispatch.
Snapshot QA
Actions → Publish snapshot → Run workflow, enter PR number. Install with pnpm add vetro-ui@pr-<number>.
Cheat sheet
bash
pnpm changeset # add a changeset (interactive)
pnpm changeset:status # inspect pending changesetsConfig: .changeset/config.json.
See also
- CI — release workflows and secrets
- Git conventions