Skip to content

docs(release): bump with npm version, matching the sibling repos #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kboshold merged 1 commit into from
Jul 31, 2026
Merged

docs(release): bump with npm version, matching the sibling repos #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,20 @@ fails at publish on auth, having changed nothing.

## Cutting a release

1. Bump `package.json` to `X.Y.Z` and merge to `main`.
2. `git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z`
3. `gh release create vX.Y.Z --title vX.Y.Z --generate-notes`, then **publish**
it. A draft triggers nothing.
From `main`, up to date. `npm version` bumps `package.json`, commits it with the
bare version as the subject, and tags that commit, so the bump and the tag cannot
drift apart.

```sh
npm version minor # or patch / major
git push --follow-tags
gh release create vX.Y.Z --title vX.Y.Z --generate-notes
```

Then **publish** the release. A draft triggers nothing.

The bump commit goes straight to `main`, no PR, matching `sidebase/ssm-secrets`
and `sidebase/nuxt-auth`.

Publishing runs the workflow: checks out the tag, refuses if the tag and
`package.json` version disagree, runs `typecheck` / `test` / `lint` / `build`
Expand Down