Versioning
SemVer & release policy
@liqo/sdk follows Semantic Versioning 2.0.0. See the Changelog
for what actually shipped in each version.
What the numbers mean
Given MAJOR.MINOR.PATCH:
- MAJOR — backward-incompatible changes to the public API (renamed/removed methods, changed signatures or runtime behavior).
- MINOR — backward-compatible new features (new methods/options).
- PATCH — backward-compatible bug fixes.
The public API is what's exported from @liqo/sdk (see API Reference). Internal modules are not part of the semver contract.
API version vs SDK version
- The SDK version is the npm package version (e.g.
2.0.0). - The Liqo API version is sent as the
X-Liqo-Versionheader (currently2) and is independent of the SDK version.
Release process
- Update code and tests; ensure
npm run lint,npm run build,npm testpass. - Update CHANGELOG.md under the new version.
- Bump
versioninpackage.jsonper SemVer. - Tag the release (
vX.Y.Z) and publish (npm publish). - Complete the public release checklist — notably, resolve the
@liqo/contractspackaging before publishing.
Deprecation policy
- Deprecated members are marked with
@deprecatedJSDoc and, where practical, remain available for one major version. - Removals happen only in a MAJOR release, with guidance in the Migration Guide.
Supported versions
See SECURITY.md. Security fixes target the latest published major line.