Skip to content

Commit cc77c5d

Browse files
committed
Document compatibility with client-go / Go
Signed-off-by: Stefan Büringer [email protected]
1 parent 79b5481 commit cc77c5d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,25 @@ Contributors:
4040
* [Documentation Changes](/.github/PULL_REQUEST_TEMPLATE/docs.md)
4141
* [Test/Build/Other Changes](/.github/PULL_REQUEST_TEMPLATE/other.md)
4242

43+
## Compatibility
44+
45+
Every minor version of controller-runtime has been tested with a specific minor version of client-go. A controller-runtime minor version *may* be compatible with
46+
other client-go minor versions, but this is by chance and neither supported nor tested. In general, we create one minor version of controller-runtime
47+
for each minor version of client-go and other k8s.io/* dependencies.
48+
49+
The minimum Go version of controller-runtime is the highest minimum Go version of our Go dependencies. Usually, this will
50+
be identical to the minimum Go version of the corresponding k8s.io/* dependencies.
51+
52+
Compatible k8s.io/*, client-go and minimum Go versions can be looked up in our [go.mod](go.mod) file.
53+
54+
| | k8s.io/*, client-go | minimum Go version |
55+
|----------|:-------------------:|:------------------:|
56+
| CR v0.19 | v0.31 | 1.22 |
57+
| CR v0.18 | v0.30 | 1.22 |
58+
| CR v0.17 | v0.29 | 1.21 |
59+
| CR v0.16 | v0.28 | 1.20 |
60+
| CR v0.15 | v0.27 | 1.20 |
61+
4362
## FAQ
4463

4564
See [FAQ.md](FAQ.md)
@@ -57,6 +76,7 @@ You can reach the maintainers of this project at:
5776
- Google Group: [[email protected]](https://groups.google.com/forum/#!forum/kubebuilder)
5877

5978
## Contributing
79+
6080
Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
6181
The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
6282
Before starting any work, please either comment on an existing issue, or file a new one.

0 commit comments

Comments
 (0)