github.skymusic.top/operator-framework/operator-sdk@v0.8.2/doc/versioning.md (about) 1 # Versioning 2 3 The following is a concise explanation of how Operator SDK versions are determined. The Operator SDK versioning follows [semantic versioning][link-semver] standards. 4 5 ## Milestones 6 7 Operator SDK [milestones][link-github-milestones] represent changes to the SDK spanning multiple issues, such as a design change. Milestones help SDK developers determine how close we are to new releases, either major or minor; a milestone must be completed before a new version is released. Milestones and their involved issues are determined by maintainers. 8 9 Milestone labels have the form: `milestone-x.y.0`, where `x` and `y` are major and minor SDK versions, respectively. This particular milestone demarcates the SDK `x.y.0` release; once issues within this milestone are addressed, the release process can begin. 10 11 ## Major versions 12 13 Major version changes can break compatibility between the previous major versions; they are not necessarily backwards or forwards compatible. SDK change targets include but are not limited to: 14 15 - `operator-sdk` command and sub-commands 16 - Golang API 17 - Formats of various yaml manifest files 18 19 ## Minor versions 20 21 Minor version changes will not break compatibility between the previous minor versions; to do so is a bug. SDK changes will involve addition of optional features, non-breaking enhancements, and *minor* bug fixes identified from previous versions. 22 23 ## Patch versions 24 25 Patch versions changes are meant only for bug fixes, and will not break compatibility of the current minor version. A patch release will contain a collection of minor bug fixes, or individual major and security bug fixes, depending on severity. 26 27 [link-semver]:https://semver.org/ 28 [link-github-milestones]: https://help.github.com/en/articles/about-milestones