Skip to content

RELEASING.md

Latest commit

 

History

History
21 lines (18 loc) · 1.04 KB

RELEASING.md

File metadata and controls

21 lines (18 loc) · 1.04 KB
Raw

Releasing the TypeScript SDK

TypeScript releases use SemVer and remain 0.x while the TiDB Link HTTP API is pre-1.0.

  1. Confirm typescript/package.json declares the supported TiDB Link API version, historical revision and provisioning revision, and that the exported values match. The package README must accurately limit each baseline's scope.
  2. Update the package version and release notes.
  3. Run the local checks in CONTRIBUTING.md; CI also verifies the pinned TiDB Link contract on Node.js 22.12. Verify the current provisioning slice with npm run test:service on the service's Node.js 26 runtime and dedicated test database as documented in the package README. CI's immutable historical contract check alone does not replace actual-service evidence.
  4. Create an annotated tag named typescript-v<version>, for example typescript-v0.2.0.
  5. Push the tag. The release workflow verifies the packed package and publishes it to npm.

Do not release SDK 1.0 until the public TiDB Link HTTP contract is declared stable.