Skip to content

Commit 2f16e32

Browse files
authored
docs: describe release flow via Version Bump and Publish Package workflows (#52)
1 parent 7c24eac commit 2f16e32

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,14 @@ This will:
2222
- Prompt for your Weave project (`entity/project`) and W&B API key if not already set
2323

2424
Marketplace installs are pinned to a specific release tag rather than the
25-
repository default branch. When cutting a new release, create the matching
26-
protected tag (for example `v0.1.1`) and update the pinned ref and sha in
27-
[`src/setup.ts`](src/setup.ts) and in
28-
[`./.claude-plugin/marketplace.json`](.claude-plugin/marketplace.json)
29-
before publishing.
25+
repository default branch. New releases are cut via two GitHub Actions:
26+
27+
1. **Version Bump** — dispatched with a version like `0.1.2`. Bumps the
28+
pinned version across the repo, pins the marketplace to the resulting
29+
commit SHA, and creates and pushes the matching `v0.1.2` tag.
30+
2. **Publish Package** — dispatched with the tag (e.g. `v0.1.2`). Verifies
31+
the tag is consistent and not already published, then builds and
32+
publishes to npm.
3033

3134
Your W&B API key is available at https://wandb.ai/authorize.
3235

0 commit comments

Comments
 (0)