pipelines/docs/release/versioning-policy.md

24 lines
1.2 KiB
Markdown

# Kubeflow Pipelines Versioning Policy
Kubeflow Pipelines version format follows [semantic versioning](https://semver.org/).
Kubeflow Pipelines versions are in the format of `X.Y.Z`, where `X` is the major version,
`Y` is the minor version, and `Z` is the patch version.
As a guideline, we increment the:
* MAJOR version when we make breaking changes on [stable features](./feature-status.md#stable-features).
* MINOR version when we add functionality in a backwards compatible manner.
* PATCH version when we make backwards compatible bug fixes.
In reality, we are not following the guideline strictly. For example, a PATCH version might include a backward compatible new feature that is considered to be low-risk.
Additionally, we do pre-releases as an extension in the format of `X.Y.Z-rc.N`
where `N` is a number. The appendix indicates the Nth release candidate before
an upcoming public release named `X.Y.Z`.
The Kubeflow Pipelines version `X.Y.Z` refers to the version (git tag) of the released
Kubeflow Pipelines. Versions include all released artifacts, such as:
* `kfp` and `kfp-server-api` python packages.
* Install manifests.
* Docker images on gcr.io/ml-pipeline.
* First party components.