From 8f132a763a45a4e6ecf8399e0e926bd7713d2bfa Mon Sep 17 00:00:00 2001 From: oraz Date: Sun, 16 Jun 2024 09:12:10 +0300 Subject: [PATCH] Update documentation on go-verify changes Update makefile and one doc file docomentation with the change of go-verify over using vendor and tidy --- docs/updating-dependencies.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/updating-dependencies.md b/docs/updating-dependencies.md index 83a574481b9..56b00bbec31 100644 --- a/docs/updating-dependencies.md +++ b/docs/updating-dependencies.md @@ -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 @@ -43,8 +42,7 @@ the PR, one can simply call go get @ OR go get -u @ -go mod tidy -compat=1.20 -go mod vendor +make go-verify ``` --- @@ -52,8 +50,8 @@ go mod vendor **NOTE** vendoring is required as ARO mirrors all dependencies locally for the CI reliability and reproducibility. -**NOTE** that when running `go mod vendor` only modules that are used in the -source code will be vendored in. +**NOTE** that running `make go-verify` adds missing (and remove unused) modules, +make a vendored copy to the *vendor* direcory and then verifies that the dependencies have expected content. **NOTE** when updating a package modified in `hack/update-go-module-dependencies.sh` changes have to be made there also. Otherwise next run of `make vendor` will