| name | release |
| description | Releases pi-spark to npm via Release Please. Use when asked to publish a new version or apply a patch/minor/major or explicit-version release. |
Release
pi-spark publishes to npm via Release Please. Pushing to main runs .github/workflows/release.yml.
Choose the version
- Releasable
feat/fix commits are already on main → Release Please computes the next version. Skip to "Merge the release PR".
- Otherwise (docs/chore-only changes, or to force a specific version) → drive the release with a
Release-As footer.
Commit with Release-As
Use one commit carrying a Release-As: x.y.z footer that sets the next version:
-
The commit has real changes → put the footer on that same commit.
git commit -m "docs: polish README" -m "Release-As: 0.11.3"
-
You only need to trigger a release → use an empty commit.
git commit --allow-empty -m "chore: trigger release 0.11.3" -m "Release-As: 0.11.3"
Then push the commit.
Merge the release PR
Release Please opens or updates a single PR labeled autorelease: pending. If none appears, the run is still going or there are no releasable commits — re-check after the run; don't hand-create it.
gh pr list --label "autorelease: pending" --state open --json number,title
gh pr view <number> --json files
gh pr merge <number> --squash
git checkout main && git pull
Don't hand-edit the version bump. Merging triggers the workflow again to tag, create the GitHub release, and publish to npm.
Verify
Watch the publish run triggered by the merge:
gh run watch "$(gh run list --workflow=release.yml --branch=main --limit=1 --json databaseId -q '.[0].databaseId')"
Finally, report the released version and release URL.
