Add yarn release script#333
Merged
TrevorBurnham merged 2 commits intojameskerr:mainfrom May 6, 2026
Merged
Conversation
`bin/release.mjs` runs the prerequisite checks, bumps the version, tags, pushes, and opens a GitHub Release draft. The tag push is what triggers `.github/workflows/publish.yml`, which publishes to npm via Trusted Publishing (OIDC). Usage: `yarn release <patch|minor|major|X.Y.Z>`. Flags: `--preview`, `--any-branch`, `--no-tests`, `--yes`.
There was a problem hiding this comment.
Pull request overview
Adds a repo-root yarn release workflow (modeled after np, but monorepo-friendly) to automate version bumping, tagging, pushing, and opening a GitHub Release draft, plus updates contributor docs to match the new process.
Changes:
- Add
releasescript entry to the rootpackage.jsonto runbin/release.mjs. - Replace manual release instructions in
CONTRIBUTING.mdwith the scripted flow + flags. - Introduce
bin/release.mjsimplementing branch/cleanliness checks, version bump, commit/tag, push, andghrelease draft creation.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| package.json | Adds yarn release script entry pointing at the new release CLI. |
| CONTRIBUTING.md | Documents the new scripted release process and flags. |
| bin/release.mjs | Implements the release automation (checks, bump, commit/tag, push, draft release). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
--preview only suppresses writes (commit, tag, push, release draft); git reads and the build still run. --any-branch skips both the main check and the remote sync check.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a release script modeled after np. (np can't be used directly because it doesn't support monorepos.) The new script:
The tag push triggers the GitHub workflow that publishes to npm.
Usage
Flags:
--preview,--any-branch,--no-tests,--yes.