Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ vp run test

## Release

See [RELEASE.md](RELEASE.md) for the full release checklist and versioning
contract.

```bash
vp run release:patch
vp run release:minor
Expand Down
51 changes: 51 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Release Process

This repository publishes a Rust core crate plus JavaScript packages generated
from the Node and WASM bindings.

## Versioning

- Keep `Cargo.toml` workspace version as the source of truth.
- Keep npm package versions synchronized with the workspace version.
- Use semver for public behavior changes, including Rust API, Node API, WASM API,
wire-format behavior, and supported platform changes.
- Treat pre-1.0 minor releases as compatibility boundaries.

## Dry Run

Preview a version bump without writing files or creating a tag:

```bash
vp run release:patch -- --dry-run --no-tag
```

Use `minor`, `alpha`, or `beta` for the corresponding release line.

## Release Checklist

Run the full CI-equivalent check from a clean worktree:

```bash
vp install
vp run fmt -- --check
vp run lint
vp run check
vp run test
vp run build:node
vp run build:wasm
```

Inspect package contents before publishing:

```bash
pnpm --dir npm/fastsse_node pack --dry-run
pnpm --dir npm/fastsse_wasm pack --dry-run
```

Create the release bump and annotated tag:

```bash
vp run release:patch
```

Push the release commit and tag together after review.
Loading