Operations
Release checklist
The maintainer checklist for cutting an @weave-kit/engine release.
Run through this before npm publish. The engine is the first package in the
publish order (engine → client → create-weavekit-app); the dependent
packages pin @weave-kit/engine to the new version afterwards.
1. Version
-
package.jsonversionmatchessrc/version.ts(version) — a test / the scaffolder assumes they agree. - Optional prerelease tag carried through both (semver
X.Y.Z; pre-1.0 breaking changes are allowed, post-1.0 additively only).
2. Changelog
-
CHANGELOG.mdhas a section for the version (Keep a Changelog: Added / Changed / Fixed / Removed), written for consumers.
3. Contract version
- If the change breaks a frozen contract (schema/workflow format, REST routes, MCP tool names, event types, error codes, public exports) → bump
CONTRACT_VERSION(src/version.ts). -
tests/unit/contract-freeze.test.tspasses (it pins the frozen values).
4. Generated files & docs
- Regenerate the OpenAPI document and commit it:
npm run openapi:docs(CI fails on drift). - Docs links stay reachable from
docs/README.md:npm run lint(runs the docs-link + memory-size guards). - Public README (
README.md) reflects notable capabilities added since the last release.
5. Build & verify
-
npm run buildproducesdist/(the published artifact). -
npm run typecheck·npm run lint·npm run test(unit + PostgreSQL e2e) all green. -
npm run test:coveragemeets the security-critical thresholds. -
node scripts/check-exports.mjs—package.json#exportstargets exist and the contract names are exported. -
npm packthen install the tarball in a scratch project andimport('@weave-kit/engine')(CI does this).
6. Publish
-
npm publish --access public(requires the OTP); orderengine→client→create-weavekit-app. - After engine publishes, poll
npm view @weave-kit/engine versionand bump the dependents' ranges before publishing them. -
git tag vX.Y.Zand push the tag.
7. Post-release
- Sync the docs site from the new tag.
- Confirm a fresh
create-weavekit-appscaffold +weave doctor+weave migrateworks against the published version.