Skip to main content

​
Versioning and release policy

This policy is mandatory for SDK delivery.
Any public behavior change must include a version decision and release-note update in the same change set.

​
Current line

  • Active release line: v1.5
  • Current patch in codebase: 1.5.0 (sdk-version.json)

​
Versioning model

Use semantic versioning (MAJOR.MINOR.PATCH) for all externally visible SDK releases.
  • Patch (1.5.1): bug fixes and non-breaking improvements
  • Minor (1.6.0): additive feature iteration
  • Major (2.0.0): breaking contract changes
If an API contract changes in a backward-incompatible way, you must cut a new major release line.

​
Required for every release

  1. Bump sdk-version.json.
  2. Add or update docs/releases/vX.Y.Z.mdx.
  3. Keep docs/releases/vX.Y.mdx line summary current.
  4. Update docs/releases/index.mdx links.
No release is complete until version bump, release notes, and docs navigation are all updated together.

​
Consistency gate

If a pull request changes any public behavior, it must include:
  • a version update in sdk-version.json
  • release-note updates under docs/releases/
  • documentation updates for affected public endpoints or user-visible behavior