Versioning Policy

Versioning Policy#

The IBM watsonx.data intelligence SDK follows Semantic Versioning 2.0.0.

Version Format#

Version numbers are in the format MAJOR.MINOR.PATCH, for example: 0.5.0

  • MAJOR version: Incremented for incompatible API changes

  • MINOR version: Incremented for new functionality in a backward-compatible manner

  • PATCH version: Incremented for backward-compatible bug fixes

Pre-release Versions#

Pre-release versions may include additional labels:

  • Alpha (0.5.0-alpha.1): Early development, API may change significantly

  • Beta (0.5.0-beta.1): Feature complete, but may have bugs

  • Release Candidate (0.5.0-rc.1): Final testing before release

Deprecation Policy#

When we need to remove or change functionality:

  1. Deprecation Warning: The feature is marked as deprecated in the current MINOR version

  2. Documentation: Deprecation is documented in release notes with migration guidance

  3. Removal: The feature is removed in the next MAJOR version

Example:

  • Version 0.5.0: Feature X is marked as deprecated

  • Version 0.6.0: Feature X still works but shows deprecation warnings

  • Version 1.0.0: Feature X is removed

Backward Compatibility#

Within a MAJOR version:

  • MINOR updates are backward compatible

  • PATCH updates are backward compatible

  • Existing code should continue to work without modifications

Breaking Changes#

Breaking changes only occur in MAJOR version updates. When upgrading across MAJOR versions:

  • Review the migration guide in the release notes

  • Update your code to use new APIs

  • Test thoroughly before deploying to production

Module Versioning#

The SDK uses a unified version number across all modules:

  • Common modules (authentication, configuration)

  • DQ Validator module (data quality validation)

  • Future modules (as they are added)

All modules share the same version number to ensure compatibility.

Version History#

See Release Notes for detailed version history and changes.

Checking Your Version#

To check your installed version:

$ pip show data-intelligence-sdk

Or in Python:

>>> import wxdi.dq_validator
>>> print(dq_validator.__version__)
1.0.0

Support Policy#

  • Current Version: Full support with bug fixes and new features

  • Previous MINOR Version: Security fixes and critical bug fixes for 6 months

  • Older Versions: No active support (upgrade recommended)

We recommend always using the latest version for the best experience and security.