Release Versioning
Version Scheme
The SDK uses semantic versioning: MAJOR.MINOR.PATCH
- MAJOR: Breaking API changes or platform support shifts.
- MINOR: Backward-compatible feature additions.
- PATCH: Bug fixes and internal improvements.
Before Upgrading Versions
| Type | Action to take |
|---|---|
| Patch | Upgrade anytime |
| Minor | Review release notes |
| Major | Review release notes and migration guide. Plan migration work. |
Detecting Current Version
Use getSdkVersion() from the configuration API at runtime. Consider logging the version on startup for debugging.
Compatibility Matrix (Indicative)
| SDK Version | Kotlin | Android Min SDK | iOS Deployment Target | Web Bundler |
|---|---|---|---|---|
| 4.x | 2.2.0 | 28 | iOS 13+ | Any modern (Vite/Webpack/Rspack) |
Breaking Change Policy
Deprecated features remain for at least one MINOR version. Subscribe to repository release notifications and review the changelog before upgrading.
Testing After a Version Upgrade
Smoke test checklist:
- Calling
enablesucceeds - Linking and unlinking a contact works
- Push token registration succeeds and push messages arrive
- Custom events appear in SAP Engagement Cloud
- Deep link tracking functions correctly
Source Distribution Notes
- Multiplatform artifacts are published to Maven Central.
- Swift artifacts are available through Swift Package Manager.
- The JavaScript bundle includes TypeScript definitions.