build/go/README.md

Go dependency managment
=======================

Status: managed by [Gazelle](https://github.com/bazelbuild/bazel-gazelle).


    .--------.
    | go.mod |------------.
    '--------'            |
        | go mod tidy     |
        V                 |
    .--------.            |
    | go.sum |-----------.|
    '--------'            |
                          | bazel run //:gazelle
                          V
                   .----------------.
                   | **/BUILD.bazel |.
                   '----------------'|
                    '----------------'
                          | bazel build //...
                          V
                   .-----------------.
                   | build artifacts |
                   '-----------------'

Updating and adding new dependencies
------------------------------------

Add a Go dependency to your code, then:

    $ go mod tidy

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.

Regenerating BUILDfiles
-----------------------

    $ bazel run //:gazelle