Skip to content

Commit 4c0ea00

Browse files
committed
Add RELEASING.md
1 parent d1250d5 commit 4c0ea00

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

RELEASING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Releasing
2+
3+
This project uses GitHub Actions to publish to npm. The publish workflow runs on two triggers:
4+
5+
- Manually via `workflow_dispatch`
6+
- Automatically when a GitHub Release is published
7+
8+
## Steps to cut a release
9+
10+
1. **Decide the new version**. Use `pnpm version` to bump the version and create a git tag for it. Commit and push the change and the tag.
11+
2. **Create a GitHub release**. Go to the tags page and create a release using the pushed tag.
12+
13+
## npm dist-tags
14+
15+
The workflow chooses the npm tag automatically based on the version string:
16+
17+
- `*-alpha.*` → published under `alpha`
18+
- `*-beta.*` → published under `beta`
19+
- `*-rc.*` → published under `next`
20+
- Everything else → `latest`
21+
22+
So, for prereleases, remember to add the correct suffix to the version (e.g. `1.2.3-beta.0`).

0 commit comments

Comments
 (0)