mirror of
				https://github.com/optim-enterprises-bv/kubernetes.git
				synced 2025-11-03 19:58:17 +00:00 
			
		
		
		
	This addresses a problem that occurred when trying the following replacement: hack/pin-dependency.sh k8s.io/klog/v2=github.com/pohly/klog/v2 flush-log-sink That itself worked, but update-vendor.sh then failed: === tidying go.mod/go.sum in staging/src/k8s.io/code-generator/examples go: k8s.io/apimachinery@v0.0.0 requires k8s.io/klog/v2@v2.4.1-0.20210909144920-0b91caa8c854: invalid version: unknown revision 0b91caa8c854 go: k8s.io/apimachinery@v0.0.0 requires k8s.io/klog/v2@v2.4.1-0.20210909144920-0b91caa8c854: invalid version: unknown revision 0b91caa8c854
		
			
				
	
	
		
			124 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Bash
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			124 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			Bash
		
	
	
		
			Executable File
		
	
	
	
	
#!/usr/bin/env bash
 | 
						|
 | 
						|
# Copyright 2019 The Kubernetes Authors.
 | 
						|
#
 | 
						|
# Licensed under the Apache License, Version 2.0 (the "License");
 | 
						|
# you may not use this file except in compliance with the License.
 | 
						|
# You may obtain a copy of the License at
 | 
						|
#
 | 
						|
#     http://www.apache.org/licenses/LICENSE-2.0
 | 
						|
#
 | 
						|
# Unless required by applicable law or agreed to in writing, software
 | 
						|
# distributed under the License is distributed on an "AS IS" BASIS,
 | 
						|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
						|
# See the License for the specific language governing permissions and
 | 
						|
# limitations under the License.
 | 
						|
 | 
						|
# This script switches to the preferred version for specified module.
 | 
						|
# Usage: `hack/pin-dependency.sh $MODULE $SHA-OR-TAG`.
 | 
						|
# Example: `hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7`.
 | 
						|
 | 
						|
set -o errexit
 | 
						|
set -o nounset
 | 
						|
set -o pipefail
 | 
						|
 | 
						|
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 | 
						|
source "${KUBE_ROOT}/hack/lib/init.sh"
 | 
						|
 | 
						|
# Explicitly opt into go modules, even though we're inside a GOPATH directory
 | 
						|
export GO111MODULE=on
 | 
						|
# Explicitly set GOFLAGS to ignore vendor, since GOFLAGS=-mod=vendor breaks dependency resolution while rebuilding vendor
 | 
						|
export GOFLAGS=-mod=mod
 | 
						|
# Detect problematic GOPROXY settings that prevent lookup of dependencies
 | 
						|
if [[ "${GOPROXY:-}" == "off" ]]; then
 | 
						|
  kube::log::error "Cannot run with \$GOPROXY=off"
 | 
						|
  exit 1
 | 
						|
fi
 | 
						|
 | 
						|
kube::golang::verify_go_version
 | 
						|
kube::util::require-jq
 | 
						|
 | 
						|
dep="${1:-}"
 | 
						|
sha="${2:-}"
 | 
						|
 | 
						|
# Specifying a different repo is optional.
 | 
						|
replacement=
 | 
						|
case ${dep} in
 | 
						|
    *=*)
 | 
						|
        # shellcheck disable=SC2001
 | 
						|
        replacement=$(echo "${dep}" | sed -e 's/.*=//')
 | 
						|
        # shellcheck disable=SC2001
 | 
						|
        dep=$(echo "${dep}" | sed -e 's/=.*//')
 | 
						|
        ;;
 | 
						|
    *)
 | 
						|
        replacement="${dep}"
 | 
						|
        ;;
 | 
						|
esac
 | 
						|
 | 
						|
if [[ -z "${dep}" || -z "${replacement}" || -z "${sha}" ]]; then
 | 
						|
  echo "Usage:"
 | 
						|
  echo "  hack/pin-dependency.sh \$MODULE[=\$REPLACEMENT] \$SHA-OR-TAG"
 | 
						|
  echo ""
 | 
						|
  echo "Examples:"
 | 
						|
  echo "  hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7"
 | 
						|
  echo "  hack/pin-dependency.sh github.com/docker/docker=github.com/johndoe/docker my-experimental-branch"
 | 
						|
  echo ""
 | 
						|
  echo "Replacing with a different repository is useful for testing but"
 | 
						|
  echo "the result should never be merged into Kubernetes!"
 | 
						|
  echo ""
 | 
						|
  exit 1
 | 
						|
fi
 | 
						|
 | 
						|
_tmp="${KUBE_ROOT}/_tmp"
 | 
						|
cleanup() {
 | 
						|
  rm -rf "${_tmp}"
 | 
						|
}
 | 
						|
trap "cleanup" EXIT SIGINT
 | 
						|
cleanup
 | 
						|
mkdir -p "${_tmp}"
 | 
						|
 | 
						|
 | 
						|
# Find the resolved version before trying to use it.
 | 
						|
echo "Running: go mod download ${replacement}@${sha}"
 | 
						|
if meta=$(go mod download -json "${replacement}@${sha}"); then
 | 
						|
    rev=$(echo "${meta}" | jq -r ".Version")
 | 
						|
else
 | 
						|
    error=$(echo "${meta}" | jq -r ".Error")
 | 
						|
    echo "Download failed: ${error}" >&2
 | 
						|
    exit 1
 | 
						|
fi
 | 
						|
echo "Resolved to ${replacement}@${rev}"
 | 
						|
 | 
						|
# Add the require directive
 | 
						|
echo "Running: go mod edit -require ${dep}@${rev}"
 | 
						|
go mod edit -require "${dep}@${rev}"
 | 
						|
 | 
						|
# Add the replace directive
 | 
						|
echo "Running: go mod edit -replace ${dep}=${replacement}@${rev}"
 | 
						|
go mod edit -replace "${dep}=${replacement}@${rev}"
 | 
						|
 | 
						|
# Propagate pinned version to staging repos that also have that dependency
 | 
						|
for repo in $(kube::util::list_staging_repos); do
 | 
						|
  pushd "staging/src/k8s.io/${repo}" >/dev/null 2>&1
 | 
						|
    if go mod edit -json | jq -e -r ".Require[] | select(.Path == \"${dep}\")" > /dev/null 2>&1; then
 | 
						|
      go mod edit -require "${dep}@${rev}"
 | 
						|
      go mod edit -replace "${dep}=${replacement}@${rev}"
 | 
						|
    fi
 | 
						|
 | 
						|
    # When replacing with a fork, always add a replace statement in all go.mod
 | 
						|
    # files (not just the root of the staging repos!) because there might be
 | 
						|
    # indirect dependencies on the fork.
 | 
						|
    #
 | 
						|
    # This is excessive, but the resulting commit should never be merged, so it
 | 
						|
    # isn't that important to get this exactly right.
 | 
						|
    if [ "${replacement}" != "${dep}" ]; then
 | 
						|
        find . -name go.mod -print | while read -r modfile; do
 | 
						|
            (cd "$(dirname "${modfile}")" && go mod edit -replace "${dep}=${replacement}@${rev}")
 | 
						|
        done
 | 
						|
    fi
 | 
						|
  popd >/dev/null 2>&1
 | 
						|
done
 | 
						|
 | 
						|
echo ""
 | 
						|
echo "Run hack/update-vendor.sh to rebuild the vendor directory"
 |