Skip to content

RELEASE.md

Latest commit

 

History

History
109 lines (75 loc) · 2.17 KB

RELEASE.md

File metadata and controls

109 lines (75 loc) · 2.17 KB
Raw

Release

Downshift has one published release channel:

  • Stable releases: GitHub Release + npm publish

Development builds are tested locally with pi -e ., pi install ., or a local packed tarball.

Commit format

Use Conventional Commits:

fix: prevent duplicate handoff prompts
feat: add steered continuation after handoff
docs: clarify prompt caching behavior
chore: update release workflow

Release Please uses these commits to generate changelog entries and version bumps.

Versioning

Release Please owns release version files:

  • package.json
  • package-lock.json
  • CHANGELOG.md
  • .release-please-manifest.json

Do not manually bump package.json for a release.

To request an exact version, create a Release-As: commit:

git commit --allow-empty \
  -m "chore: release 0.2.1" \
  -m "Release-As: 0.2.1"

git push origin main

If the repo has the helper script, use:

npm run release:as -- 0.2.1

Then run the release-please workflow manually.

Stable release flow

Stable releases are controlled through Release Please.

  1. Merge normal feature/fix PRs into main.
  2. Optional: create a Release-As: commit if the release must use an exact version.
  3. Go to GitHub Actions.
  4. Run the release-please workflow manually.
  5. Review the Release Please PR.
  6. Merge the Release Please PR when ready.
  7. The merge changes package.json, package-lock.json, CHANGELOG.md, and .release-please-manifest.json.
  8. That release-file push runs release-please again automatically.
  9. Release Please creates the GitHub Release and tag.
  10. The publish-npm job waits for the npm-publish environment approval.
  11. Approve the deployment.
  12. The package publishes to npm.

Verify:

npm view pi-downshift version
pi install npm:pi-downshift

Stable releases must use tags like:

v0.2.0
v1.0.0

Local release checks

Run:

npm run release:dry

This runs typecheck, tests, and npm pack --dry-run.

Test locally without publishing:

pi -e .

Or install from the local package path:

pi install .

Or test the packed package:

npm pack
pi install ./pi-downshift-<version>.tgz