Gazelle

External

• https://github.com/bazel-contrib/bazel-gazelle/
• https://github.com/bazel-contrib/bazel-gazelle#gazelle-build-file-generator

Internal

• Bazel Concepts
• BUILD Files

Overview

Gazelle is a BUILD file generator for Bazel projects. It can create new BUILD.bazel files for a project that follows language conventions, and it can update existing build files to include new sources, dependencies, and options.

Gazelle natively supports Go and protobuf.

Gazelle may be run by Bazel using the gazelle rule:

bazel run //:gazelle

Alternatively, it may be installed and run as a command line tool.

Aside from generating BUILD files for the local source code, Gazelle can also generate build files for external repositories as part of the go_repository rule.

Generating BUILD Files

https://github.com/bazel-contrib/bazel-gazelle#gazelle-build-file-generator

Repository Rules

https://github.com/bazel-contrib/bazel-gazelle/blob/master/repository.md#repository-rules

go_repository

https://github.com/bazel-contrib/bazel-gazelle/blob/master/repository.md#go_repository

go_repository downloads a Go project and generates build files with Gazelle if they are not already present. This is the simplest way to depend on external Go projects. When go_repository is in module mode, it saves downloaded modules in a shared, internal cache within Bazel's cache. It may be cleared with:

bazel clean --expunge

Relationship between WORKSPACE and go.mod

Describe the relationship between updating WORKSPACE and go.mod.

Download with go mod download

load("@bazel_gazelle//:deps.bzl", "go_repository")

go_repository(
    name = "com_github_pkg_errors",
    importpath = "github.com/pkg/errors",
    sum = "h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=",
    version = "v0.8.1",
)

Download Automatically via git

load("@bazel_gazelle//:deps.bzl", "go_repository")

go_repository(
    name = "com_github_pkg_errors",
    commit = "816c9085562cd7ee03e7f8188a1cfd942858cded",
    importpath = "github.com/pkg/errors",
)

Download from git fork

load("@bazel_gazelle//:deps.bzl", "go_repository")

go_repository(
    name = "com_github_pkg_errors",
    commit = "816c9085562cd7ee03e7f8188a1cfd942858cded",
    importpath = "github.com/pkg/errors",
    remote = "https://example.com/fork/github.com/pkg/errors",
    vcs = "git",
)

Document replace:

go_repository(
    name = "com_github_desertbit_grumble",
    importpath = "github.com/desertbit/grumble",
    replace = "github.com/someorg/grumble",
    sum = "h1:ae4PBi8v5MiNSSR29FNICzc1fTgF8dzKyqgl22Lf/Bt=",
    sum_hex = "130f1097a715112f91efc1b21e775fb2143a4904730042e0be919df4fd8b4135",
    version = "v1.0.0-experimental",
)

Download via HTTP

load("@bazel_gazelle//:deps.bzl", "go_repository")

go_repository(
    name = "com_github_pkg_errors",
    importpath = "github.com/pkg/errors",
    urls = ["https://codeload.github.com/pkg/errors/zip/816c9085562cd7ee03e7f8188a1cfd942858cded"],
    strip_prefix = "errors-816c9085562cd7ee03e7f8188a1cfd942858cded",
    type = "zip",
)

Download Major Version Suffixed via git

load("@bazel_gazelle//:deps.bzl", "go_repository")

go_repository(
    name = "com_github_thediveo_enumflag_v2",
    commit = "0217df583bf3d37b92798602e5061b36556bcd38",
    importpath = "github.com/thediveo/enumflag/v2",
    remote = "https://github.com/thediveo/enumflag",
    vcs = "git",
)

git_repository

https://github.com/bazel-contrib/bazel-gazelle/blob/master/repository.md#git_repository

Deprecated.

Operations

Add a go_repository Rule to WORKSPACE File

bazel run //:gazelle -- update-repos golang.org/x/sys@v0.13.0

adds the following line to the WORKSPACE file:

go_repository(
    name = "org_golang_x_sys",
    importpath = "golang.org/x/sys",
    sum = "h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=",
    version = "v0.13.0",
)