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.

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

Add new makefile targets for go mod verification #3492

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions .github/workflows/ci-go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
- run: |
go mod vendor
go mod tidy -compat=1.20
make go-verify
hack/ci-utils/isClean.sh

generate-check:
Expand Down
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ GATEKEEPER_VERSION = v3.10.0
GATEKEEPER_IMAGE ?= ${RP_IMAGE_ACR}.azurecr.io/gatekeeper:$(GATEKEEPER_VERSION)
GOTESTSUM = gotest.tools/[email protected]

# Golang version go mod tidy compatibility
GOLANG_VERSION ?= 1.20

ifneq ($(shell uname -s),Darwin)
export CGO_CFLAGS=-Dgpgme_off_t=off_t
endif
Expand Down Expand Up @@ -266,9 +269,22 @@ admin.kubeconfig:
aks.kubeconfig:
hack/get-admin-aks-kubeconfig.sh

.PHONY: go-tidy
go-tidy: # Run go mod tidy - add missing and remove unused modules.
go mod tidy -compat=${GOLANG_VERSION}

.PHONY: go-vendor
go-vendor: # Run go mod vendor - make vendored copy of dependencies.
go mod vendor

.PHONY: go-verify
go-verify: go-tidy go-vendor # Run go mod verify - verify dependencies have expected content
go mod verify

vendor:
# See comments in the script for background on why we need it
hack/update-go-module-dependencies.sh
$(MAKE) go-verify

install-go-tools:
go install ${GOTESTSUM}
Expand Down
6 changes: 2 additions & 4 deletions docs/updating-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ The reason for calling script instead of directly calling:

```bash
go get -u ./...
go mod tidy -compat=1.20
go mod vendor
make go-verify
```

is that packages modified in this script do not fully support modules and
Expand All @@ -43,8 +42,7 @@ the PR, one can simply call
go get <module>@<release> OR
go get -u <module>@<release>

go mod tidy -compat=1.20
go mod vendor
make go-verify
```

---
Expand Down
3 changes: 0 additions & 3 deletions hack/update-go-module-dependencies.sh
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,3 @@ for x in vendor/github.com/openshift/*; do
done

go get -u ./...

go mod tidy -compat=1.20
go mod vendor