← Back to docs

Recipe: SDK release checklist

Ship every SDK version with zero regressions.

1. Pre-release audit

  • All public API surfaces have doc comments.
  • Breaking changes are gated behind a semver major bump.
  • Deprecated methods carry a migration path in the JSDoc.

2. Build & test

  • CI passes on Windows, macOS, and Linux.
  • Integration suite runs against the latest three LTS runtimes.
  • Bundle size delta is under 5% vs. previous release.

3. Publish

  • Changelog is published to the docs site.
  • Git tag matches the npm registry version exactly.
  • Release notes are posted in the Discord #changelog channel.

Pro tip: Run the checklist in a fresh VM to catch implicit host dependencies before your users do.