From 7b5ca8a659352501e35837944798690ed670ad57 Mon Sep 17 00:00:00 2001 From: Stefan Bueringer Date: Wed, 7 Aug 2024 17:27:37 +0200 Subject: [PATCH] Document compatibility with k8s.io/*, client-go and Go MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stefan Büringer buringerst@vmware.com --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 6029de6ad..878de69ee 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,26 @@ export `GO111MODULE=on`. See [VERSIONING.md](VERSIONING.md). + +## Compatibility + +Every minor version of controller-tools has been tested with a specific minor version of client-go. A controller-tools minor version *may* be compatible with +other client-go minor versions, but this is by chance and neither supported nor tested. In general, we create one minor version of controller-tools +for each minor version of client-go and other k8s.io/* dependencies. + +The minimum Go version of controller-tools is the highest minimum Go version of our Go dependencies. Usually, this will +be identical to the minimum Go version of the corresponding k8s.io/* dependencies. + +Compatible k8s.io/*, client-go and minimum Go versions can be looked up in our [go.mod](go.mod) file. + +| | k8s.io/*, client-go | minimum Go version | +|----------|:-------------------:|:------------------:| +| CR v0.16 | v0.31 | 1.22 | +| CR v0.15 | v0.30 | 1.22 | +| CR v0.14 | v0.29 | 1.20 | +| CR v0.13 | v0.28 | 1.20 | +| CR v0.12 | v0.27 | 1.20 | + ## Community, discussion, contribution, and support Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).