We will update this document to reflect any change in our release mechanism.
Polyaxon is using SemVer (Semantic Versioning) for all of its open-source releases:
- Major numbers indicate breaking, backward-incompatible changes, or substantial project milestones.
- Medium numbers indicate new features, may include API changes with possible deprecations, release notes must be read carefully before upgrading between medium point releases.
- Minor numbers indicate patches, bug fixes, enhancements and feature improvements only.
Benefits
- Host and support several versions of semantically contained documentation resources.
- Clear migration paths.
Release cycles
New versions will be released:
- Whenever a major regression, bug, or security fix is made.
- Whenever a new improved functionality is developed and tested on different infrastructures.
- Every week/2 weeks/month depending on the scope of the features being developed.
Scope of semantic versioning
The following changes result in a major version bump as they are considered breaking:
- Infrastructure changes
- Removal of existing Public APIs or removal/changes of existing parameters from Public APIs
The following changes do not result in a major version bump as they are considered internal implementation details:
- Database schemas
- Frontend APIs
Compatibility between Control plane, Data/Agent plane, CLI and SDKs
Server and SDKs are versioned independently to allow for more flexibility in upgrading components:
- Control plane: Can be upgraded independently of CLI, client, and SDK versions, unless explicitly noted in release notes
- CLI, clients, and SDKs: Can remain on older versions while running newer server versions
- Data/Agent plane: Can be upgraded independently of server versions, unless explicitly noted in release notes. Control plane is always backward compatible with agents running older versions.
- Compatibility: New Data/Agent plane, CLI, clients, and SDKs features may require recent server versions
We recommend keeping the Polyaxon Server up to date to ensure access to all features and security updates.
Other components
In addition to Polyaxon's core functionality, we develop several other aspects and components that we believe have a major impact on the productivity of our users. These components will be marked separately with alpha/beta until they reach a stable state.