Release process
Releases are automated with Changesets. Nobody bumps versions or publishes by hand.
In your pull request
Section titled “In your pull request”If your PR changes a published package (shoehive or create-shoehive), add a changeset:
pnpm changesetPick the packages and the bump, then write one or two sentences for the changelog. Commit the
new file in .changeset/ with your PR. Docs-only, CI-only and example-only PRs do not need
one.
A PR that changes the public API also updates the API Extractor report
(pnpm --filter shoehive api:update) so reviewers see the change in
packages/shoehive/api/*.api.md.
What happens on main
Section titled “What happens on main”The Release workflow
runs on every push to main:
- It runs the full
pnpm check(format, lint, typecheck, tests, build, package checks). A red check stops the release. - While unreleased changesets exist, it opens or updates a Version Packages PR. That PR
bumps versions and writes each package's
CHANGELOG.mdfrom the changesets. - Merging the Version Packages PR publishes to npm with provenance.
The pending changesets are listed on the changelog page until they are released.
Prereleases
Section titled “Prereleases”Until 1.0.0, the repository is in Changesets pre mode (.changeset/pre.json): releases are
release candidates, 1.0.0-rc.x on the rc dist-tag, so npm install shoehive@rc and
npm create shoehive@rc get the latest one. To leave pre mode for the final release, run
pnpm changeset pre exit in a PR; the next Version Packages PR then publishes 1.0.0 on
latest.
The API reports in packages/shoehive/api/ are frozen from the first release candidate: a
change to a report after 1.0.0-rc.0 needs a changeset that says why, and a breaking change
waits for 2.0.
The docs site
Section titled “The docs site”This site deploys to GitHub Pages from main with the
Docs workflow, on
every push. It does not follow npm releases: it documents main.
