| Serge Bazanski | bb7db92 | 2020-04-30 12:43:10 +0200 | [diff] [blame] | 1 | Go dependency managment |
| 2 | ======================= |
| 3 | |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 4 | Status: managed by [Gazelle](https://github.com/bazelbuild/bazel-gazelle). |
| Serge Bazanski | bb7db92 | 2020-04-30 12:43:10 +0200 | [diff] [blame] | 5 | |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 6 | |
| 7 | .--------. |
| 8 | | go.mod |------------. |
| 9 | '--------' | |
| Tim Windelschmidt | e5e90a8 | 2024-07-17 23:46:22 +0200 | [diff] [blame] | 10 | | go mod tidy | |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 11 | V | |
| 12 | .--------. | |
| 13 | | go.sum |-----------.| |
| 14 | '--------' | |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 15 | | bazel run //:gazelle |
| 16 | V |
| 17 | .----------------. |
| 18 | | **/BUILD.bazel |. |
| 19 | '----------------'| |
| 20 | '----------------' |
| 21 | | bazel build //... |
| 22 | V |
| 23 | .-----------------. |
| 24 | | build artifacts | |
| 25 | '-----------------' |
| 26 | |
| 27 | Updating and adding new dependencies |
| 28 | ------------------------------------ |
| 29 | |
| 30 | Add a Go dependency to your code, then: |
| 31 | |
| 32 | $ go mod tidy |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 33 | |
| Serge Bazanski | fdc3a24 | 2022-04-06 15:56:38 +0200 | [diff] [blame] | 34 | All generated sources (eg. protobuf stubs) that are usually built by Bazel are invisible to go(mod)-based tooling. To get around this, we place `gomod-generated-placeholder.go` files in package directories that would otherwise contain generated files. These are ignored by Gazelle (and thus by Bazel builds) but not by go(mod)-based tooling. |
| Serge Bazanski | ee4bfdb | 2022-04-06 15:30:52 +0200 | [diff] [blame] | 35 | |
| 36 | Regenerating BUILDfiles |
| 37 | ----------------------- |
| 38 | |
| 39 | $ bazel run //:gazelle |