github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 11:50:44 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #111130 from thockin/comments-about-go-install

Browse Source 
Add comments around `go install`
This commit is contained in:
Kubernetes Prow Robot 2022-07-14 13:19:20 -07:00 committed by GitHub
commit 6a1b9e1c50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
hack/lib/golang.sh
View File

@ -513,9 +513,28 @@ EOF
kube::golang::setup_env() { kube::golang::setup_env() {
kube::golang::verify_go_version kube::golang::verify_go_version
# Set up GOPATH. We have tools which depend on being in a GOPATH (see
# hack/run-in-gopath.sh).
#
# Even in module mode, we need to set GOPATH for `go build` and `go install`
# to work. We build various tools (usually via `go install`) from a lot of
# scripts.
# * We can't set GOBIN because that does not work on cross-compiles.
# * We could use `go build -o <something>`, but it's subtle when it comes
# to cross-compiles and whether the <something> is a file or a directory,
# and EVERY caller has to get it *just* right.
# * We could leave GOPATH alone and let `go install` write binaries
# wherever the user's GOPATH says (or doesn't say).
#
# Instead we set it to a phony local path and process the results ourselves.
# In particular, GOPATH[0]/bin will be used for `go install`, with
# cross-compiles adding an extra directory under that.
#
# Eventually, when we no longer rely on run-in-gopath.sh we may be able to
# simplify this some.
kube::golang::create_gopath_tree kube::golang::create_gopath_tree
export GOPATH="${KUBE_GOPATH}" export GOPATH="${KUBE_GOPATH}"
export GOCACHE="${KUBE_GOPATH}/cache" export GOCACHE="${KUBE_GOPATH}/cache"
# Make sure our own Go binaries are in PATH. # Make sure our own Go binaries are in PATH.
@ -523,8 +542,7 @@ kube::golang::setup_env() {
# Change directories so that we are within the GOPATH. Some tools get really # Change directories so that we are within the GOPATH. Some tools get really
# upset if this is not true. We use a whole fake GOPATH here to collect the # upset if this is not true. We use a whole fake GOPATH here to collect the
# resultant binaries. Go will not let us use GOBIN with `go install` and # resultant binaries.
# cross-compiling, and `go install -o <file>` only works for a single pkg.
local subdir local subdir
subdir=$(kube::realpath . | sed "s|${KUBE_ROOT}||") subdir=$(kube::realpath . | sed "s|${KUBE_ROOT}||")
cd "${KUBE_GOPATH}/src/${KUBE_GO_PACKAGE}/${subdir}" || return 1 cd "${KUBE_GOPATH}/src/${KUBE_GO_PACKAGE}/${subdir}" || return 1
@ -534,6 +552,7 @@ kube::golang::setup_env() {
export GOROOT export GOROOT
# Unset GOBIN in case it already exists in the current session. # Unset GOBIN in case it already exists in the current session.
# Cross-compiles will not work with it set.
unset GOBIN unset GOBIN
# This seems to matter to some tools # This seems to matter to some tools
@ -656,6 +675,8 @@ kube::golang::delete_coverage_dummy_test() {
# go install. If coverage is enabled, builds covered binaries using go test, temporarily # go install. If coverage is enabled, builds covered binaries using go test, temporarily
# producing the required unit test files and then cleaning up after itself. # producing the required unit test files and then cleaning up after itself.
# Non-covered binaries are then built using go install as usual. # Non-covered binaries are then built using go install as usual.
#
# See comments in kube::golang::setup_env regarding where built binaries go.
kube::golang::build_some_binaries() { kube::golang::build_some_binaries() {
if [[ -n "${KUBE_BUILD_WITH_COVERAGE:-}" ]]; then if [[ -n "${KUBE_BUILD_WITH_COVERAGE:-}" ]]; then
local -a uncovered=() local -a uncovered=()