Skip to content

release.md

Latest commit

 

History

History
48 lines (34 loc) · 1017 Bytes

release.md

File metadata and controls

48 lines (34 loc) · 1017 Bytes
Raw

Release checklist

Patch/minor release workflow

  1. Ensure CHANGELOG.md is updated under [Unreleased].
    • Optional automation (requires git-cliff):
just changelog preview
just changelog sync
  1. Run the release script:
npm run release:patch
# or
npm run release:minor
  1. Push the tag:
npm run release:push
  1. Push branch and tag:
npm run release:push
  1. GitHub Actions (.github/workflows/release.yml) runs automatically on tag push and will:
  • publish to npm (requires repository secret NPM_TOKEN)
  • publish/update the GitHub release from CHANGELOG.md

Optional manual GitHub release publish/update:

npm run release:github

Notes

  • The release scripts handle version bumps, CHANGELOG finalization, commit, and tag creation.
  • Publishing is CI-driven on tag push via .github/workflows/release.yml.
  • GitHub releases are created or updated from the matching CHANGELOG.md section.
  • Major releases are not supported by policy.