-
Notifications
You must be signed in to change notification settings - Fork 416
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #498 from DirectXMan12/docs/version
📖 Add versioning guidelines
- Loading branch information
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Versioning and Releasing in controller-tools | ||
|
||
We follow the [common KubeBuilder versioning guidelines][guidelines], and | ||
use the corresponding tooling. | ||
|
||
For the purposes of the aforementioned guidelines, controller-tools counts | ||
as a "library project", but otherwise follows the guidelines closely. | ||
|
||
[guidelines]: https://sigs.k8s.io/kubebuilder-release-tools/VERSIONING.md | ||
|
||
## Compatibility and Release Support | ||
|
||
For release branches, we generally do not support older branches. This | ||
may change in the future. | ||
|
||
Compability-wise, remember that changes to generation defaults are | ||
breaking changes. | ||
|
||
## Updates to Other Projects on Release | ||
|
||
When you release, you'll need to perform updates in other KubeBuilder | ||
projects: | ||
|
||
- Update the controller-tools version used to generate the KubeBuilder | ||
book at [docs/book/install-and-build.sh][book-script] | ||
|
||
[book-script]: https://sigs.k8s.io/kubebuilder/docs/book/install-and-build.sh |