Skip to content

Commit

Permalink
Update documentation on go-verify changes
Browse files Browse the repository at this point in the history
Update makefile and one doc file docomentation with the change of go-verify over using vendor and tidy
  • Loading branch information
razo7 committed May 22, 2024
1 parent e002c6e commit 43f6765
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 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,17 +42,16 @@ 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
```

---

**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
Expand Down

0 comments on commit 43f6765

Please sign in to comment.