From c156fa7da648509abc2f7a1c5374a1bc2b129b83 Mon Sep 17 00:00:00 2001 From: Prashant Joshi Date: Wed, 20 Jan 2021 20:41:56 -0800 Subject: [PATCH 1/3] updated README to include instructions on building standalone controller-gen binary --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 39f3cd2b0..b1d1e5c72 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,18 @@ This project uses Go modules to manage its dependencies, so feel free to work fr of your `GOPATH`. However, if you'd like to continue to work from within your `GOPATH`, please export `GO111MODULE=on`. +!!! tip "Building controller-gen" + Some projects may not require all the libraries but just need the controller-gen binary + or a particular version of it. + The controller-gen can be built by running the following - + + `go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1` + + Note: `GO111MODULE=on` is required and the controller-gen binary would be installed + at `$GOPATH/bin`, see also + [`#520`](https://github.com/kubernetes-sigs/controller-tools/issues/520). + + ## Releasing and Versioning See [VERSIONING.md](VERSIONING.md). From ff9b2b91bd97052056779ba6daffaabaaceff4da Mon Sep 17 00:00:00 2001 From: Prashant Joshi Date: Wed, 20 Jan 2021 22:47:16 -0800 Subject: [PATCH 2/3] updated README to include instructions on building standalone controller-gen binary --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b1d1e5c72..c69e05873 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,12 @@ This project uses Go modules to manage its dependencies, so feel free to work fr of your `GOPATH`. However, if you'd like to continue to work from within your `GOPATH`, please export `GO111MODULE=on`. -!!! tip "Building controller-gen" - Some projects may not require all the libraries but just need the controller-gen binary - or a particular version of it. - The controller-gen can be built by running the following - +If just the controller-gen binary is required then run- - `go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1` + go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1 - Note: `GO111MODULE=on` is required and the controller-gen binary would be installed - at `$GOPATH/bin`, see also - [`#520`](https://github.com/kubernetes-sigs/controller-tools/issues/520). +Please export `GO111MODULE=on` and the binary would be installed at `$GOPATH/bin`, + see also [`#520`](https://github.com/kubernetes-sigs/controller-tools/issues/520). ## Releasing and Versioning From c0741ba173e3c2d438200d910ae619fabd5be73d Mon Sep 17 00:00:00 2001 From: Prashant Joshi Date: Thu, 21 Jan 2021 15:18:55 -0800 Subject: [PATCH 3/3] Incorporated review comments --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c69e05873..291366389 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ This project uses Go modules to manage its dependencies, so feel free to work fr of your `GOPATH`. However, if you'd like to continue to work from within your `GOPATH`, please export `GO111MODULE=on`. -If just the controller-gen binary is required then run- - - go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1 - -Please export `GO111MODULE=on` and the binary would be installed at `$GOPATH/bin`, - see also [`#520`](https://github.com/kubernetes-sigs/controller-tools/issues/520). +## Install +To install only the controller-gen binary : +```sh +go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1 +``` +**NOTE** Please export `GO111MODULE=on` and the binary would be installed at `$GOPATH/bin`. ## Releasing and Versioning