Migration Guides
This section provides migration guides for upgrading between TrustWeave versions and understanding deprecation policies.
Version Compatibility Matrix
| TrustWeave Version | Kotlin | Java | Gradle | Status |
|---|---|---|---|---|
| 1.0.0-SNAPSHOT | 2.2.0+ | 21+ | 8.5+ | Current |
Deprecation Policy
TrustWeave follows semantic versioning (SemVer) principles:
- Major versions (X.0.0): Breaking changes allowed
- Minor versions (0.X.0): New features, backward compatible
- Patch versions (0.0.X): Bug fixes only
Deprecation Timeline
- Deprecation Announcement: Deprecated APIs are marked with
@Deprecatedannotation and documented in CHANGELOG - Minimum Deprecation Period: 6 months before removal
- Removal: Deprecated APIs are removed in the next major version
How to Handle Deprecations
- Check CHANGELOG: Review deprecation notices in CHANGELOG.md
- Update Code: Replace deprecated APIs with recommended alternatives
- Test Thoroughly: Ensure your code works with new APIs
- Plan Migration: Schedule migration before major version upgrade
Migration Guides
Migrating to Phase 4 API (Service Layer Removal)
See Migrating to Phase 4 API for migration from service layer (dids, credentials, wallets) to direct methods:
- Service layer removal
- Direct methods migration
- Error handling updates for sealed results
- Common migration issues
Migrating to 1.0.0
See Migrating to 1.0.0 for detailed migration instructions covering:
- Type-safe options migration
- Result-based API migration
- Error handling updates
- Plugin lifecycle changes
Migrating to Typed Values API
See Migrating to Typed Values API for migration from String-based parameters to type-safe typed values:
- Replacing String parameters with
Did,KeyId, etc. - Updating DSL builders to use typed values
- Benefits of compile-time type safety
- Common migration issues and solutions
Breaking Changes
Breaking changes are clearly marked in the CHANGELOG with migration instructions. Common breaking changes include:
- API signature changes
- Return type changes
- Exception type changes
- Configuration format changes
Getting Help
If you encounter issues during migration:
- Check the FAQ for common questions
- Review Error Handling for error patterns
- Open an issue on GitHub with migration details
- Contact support at www.geoknoesis.com