Skip to content

Commit ba001c7

Browse files
committed
Add versioning guidelines
This adds versioning/releasing guidelines that reference the common guidelines in kubebuilder-release-tools, with a few controller-tools-specific reminders.
1 parent 6c9ddb1 commit ba001c7

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ This project uses Go modules to manage its dependencies, so feel free to work fr
1313
of your `GOPATH`. However, if you'd like to continue to work from within your `GOPATH`, please
1414
export `GO111MODULE=on`.
1515

16+
## Releasing and Versioning
17+
18+
See [VERSIONING.md](VERSIONING.md).
19+
1620
## Community, discussion, contribution, and support
1721

1822
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).

VERSIONING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Versioning and Releasing in controller-tools
2+
3+
We follow the [common KubeBuilder versioning guidelines][guidelines], and
4+
use the corresponding tooling.
5+
6+
For the purposes of the aforementioned guidelines, controller-tools counts
7+
as a "library project", but otherwise follows the guidelines closely.
8+
9+
[guidelines]: https://sigs.k8s.io/kubebuilder-release-tools/VERSIONING.md
10+
11+
## Compatibility and Release Support
12+
13+
For release branches, we generally do not support older branches. This
14+
may change in the future.
15+
16+
Compability-wise, remember that changes to generation defaults are
17+
breaking changes.
18+
19+
## Updates to Other Projects on Release
20+
21+
When you release, you'll need to perform updates in other KubeBuilder
22+
projects:
23+
24+
- Update the controller-tools version used to generate the KubeBuilder
25+
book at [docs/book/install-and-build.sh][book-script]
26+
27+
[book-script]: https://sigs.k8s.io/kubebuilder/docs/book/install-and-build.sh

0 commit comments

Comments
 (0)