Versioning & releases

@rogue/console-sdk uses Semantic Versioning with Changesets. This page records the policy so you know what a version bump promises before you upgrade.

Pre-1.0 convention (0.x)

While the major version is 0, the usual semver slots shift down by one:

Bump	Example	Meaning
minor	0.1.0 → 0.2.0	A breaking change to the public API.
patch	0.1.0 → 0.1.1	Everything else — new features, fixes, docs.

Pin accordingly: ~0.1.0 (patch-only) is safe for automatic updates; a minor bump is a deliberate migration.

The API-surface gate

The public surface — the root barrel and every subpath (/testing, /units, /storage/async-storage) — is rolled up into a committed snapshot, etc/api-surface.md. CI regenerates it and fails on any drift that is not accompanied by a changeset whose bump type matches the diff. A breaking surface diff demands a minor bump (major once we are past 1.0); an additive one demands a patch.

This makes accidental public-surface drift a red check and keeps the generated API reference provably in sync with the shipped .d.ts files.

Additive-only evolution

The API evolves additively. Anything that must be removed goes through a release that marks it @deprecated in JSDoc first, so an upgrade never breaks silently.

Frozen console contracts

Some things are versioned independently of the package and never change shape once frozen:

• BLE protocol frame formats and the OTA frame codec are characterization-pinned — goldens generated once, asserted forever.
• Firmware-parity math (the /units subpath) reproduces the console screen exactly, quirks and all; see units & formatting.
• The saved-devices storage schema carries a schema key with forward-only migrations run during hydration, so an upgraded app reads an older device store without data loss.

The road to 1.0.0

1.0.0 ships when the example app passes the hardware-verified, release-mode smoke test — scan → connect → workout → save → sync — on the two most recent Expo SDKs. Until then, treat the surface as stabilizing rather than stable.

Support statement

• React ≥ 19.1
• React Native 0.79+ on the New Architecture
• Tested on the two most recent Expo SDKs

See installation for the full support matrix and peer requirements.

Docs versioning

The docs site currently publishes a single version tracking the latest release. Multi-major docs (via starlight-versions) will be revisited when a breaking major approaches — until then, one version keeps navigation simple.