| name | release |
| description | Release package changes through the repository's GitHub Actions workflow. |
Release through GitHub Actions
Use this workflow when preparing and publishing package changes from this repository.
Release policy
- Releases are triggered by pushing to
main; do not publish packages from a local shell.
- Keep the working tree reviewable before release. Check
git status --short and inspect all changed files.
- Update the affected package changelog before pushing a release commit.
- When bumping a lower-level package, include any higher-level packages that depend on it in the bump set when their published dependency ranges or user-facing behavior need to move with the lower-level release.
- Run the same local checks that the release workflow runs when practical:
pnpm build and pnpm test.
- Push the release commit to
main, then monitor the Release GitHub Actions workflow.
Steps
- Inspect changes with
git status --short and git diff.
- Confirm the affected package versions and changelog entries, including higher-level dependents when a lower-level package is bumped.
- Run
pnpm build.
- Run
pnpm test.
- Commit the code, changelog, and release instructions together.
- Push
main to origin.
- Confirm the
Release workflow starts and completes successfully.
Notes
.github/workflows/release.yml stages release packages in dependency order and skips versions already published to npm.
- If the package set changes, update the workflow package list before releasing.
- If Actions fails, fix the repository state and push another commit instead of trying to publish manually.