// Create a new release using changesets and CI automation. Use when ready to publish a new version.
| name | release |
| description | Create a new release using changesets and CI automation. Use when ready to publish a new version. |
This project uses changesets for versioning and automated CI for releases.
nix-shell --run "bun run changeset"
This prompts for:
A markdown file is created in .changeset/ (e.g., .changeset/funny-dogs-dance.md).
git add .changeset/*.md
git commit -m "chore: add changeset for <feature>"
git push origin main
The version.yml workflow:
.changeset/bun run version which:
package.jsonCHANGELOG.mdrelease/v0.2.0)When merged, CI:
dist/pmd-darwin-arm64, dist/pmd-linux-arm64)v0.2.0)| Type | When to use | Example |
|---|---|---|
| patch | Bug fixes, minor tweaks | 0.1.0 -> 0.1.1 |
| minor | New features, non-breaking | 0.1.0 -> 0.2.0 |
| major | Breaking changes | 0.1.0 -> 1.0.0 |
To force a release for the current version without changesets:
.changeset/config.json - Changeset configuration.github/workflows/version.yml - Release automationscripts/version.ts - Version script run by CICHANGELOG.md - Auto-updated changelog.changeset/ (not just README.md)bun run build works locallycachix/install-nix-action)