Skip to content

Latest commit

 

History

History
248 lines (171 loc) · 14 KB

README.md

File metadata and controls

248 lines (171 loc) · 14 KB
Raw

Bazelisk

A user-friendly launcher for Bazel.

About Bazelisk

Bazelisk is a wrapper for Bazel written in Go. It automatically picks a good version of Bazel given your current working directory, downloads it from the official server (if required) and then transparently passes through all command-line arguments to the real Bazel binary. You can call it just like you would call Bazel.

Installation

On macOS: brew install bazelisk.

On Windows: choco install bazelisk.

Each adds bazelisk to the PATH as both bazelisk and bazel.

On Linux: You can download Bazelisk binary on our Releases page and add it to your PATH manually, which also works on macOS and Windows.

Bazelisk is also published to npm. Frontend developers may want to install it with npm install -g @bazel/bazelisk.

You will notice that it serves an analogous function for Bazel as the nvm utility which manages your version of Node.js.

Some ideas how to use it:

  • Install it as the bazel binary in your PATH (e.g. copy it to /usr/local/bin/bazel). Never worry about upgrading Bazel to the latest version again.
  • Check it into your repository and recommend users to build your software via ./bazelisk build //my:software. That way, even someone who has never used Bazel or doesn't have it installed can build your software.
  • As a company using Bazel or as a project owner, add a .bazelversion file to your repository. This will tell Bazelisk to use the exact version specified in the file when running in your workspace. The fact that it's versioned inside your repository will then allow for atomic upgrades of Bazel including all necessary changes. If you install Bazelisk as bazel on your CI machines, too, you can even test Bazel upgrades via a normal presubmit / pull request. It will also ensure that users will not try to build your project with an incompatible version of Bazel, which is often a cause for frustration and failing builds. (But see the note below about ensuring your developers install Bazelisk.)

Before Bazelisk was rewritten in Go, it was a Python script. This still works and has the advantage that you can run it on any platform that has a Python interpreter, but is currently unmaintained and it doesn't support as many features. The documentation below describes the newer Go version only.

How does Bazelisk know which Bazel version to run?

It uses a simple algorithm:

  • If the environment variable USE_BAZEL_VERSION is set, it will use the version specified in the value.
  • Otherwise, if a .bazeliskrc file exists in the workspace root and contains the USE_BAZEL_VERSION variable, this version will be used.
  • Otherwise, if a .bazelversion file exists in the current directory or recursively any parent directory, it will read the file and use the version specified in it.
  • Otherwise, if the environment variable USE_BAZEL_FALLBACK_VERSION is set to one of the following formats:
    • If set to a value starting with error:, it will report an error and version detection will fail.
    • If set to a value starting with warn:, it will report a warning and use the version specified after the prefix.
    • If set to a value starting with silent:, it will use the version specified after the prefix.
  • Otherwise, it will use the official latest Bazel release.

A version can optionally be prefixed with a fork name. The fork and version should be separated by slash: <FORK>/<VERSION>. Please see the next section for how to work with forks.

Bazelisk currently understands the following formats for version labels:

  • latest means the latest stable (LTS) version of Bazel as released on GitHub. Previous releases can be specified via latest-1, latest-2 etc.
  • A version number like 0.17.2 means that exact version of Bazel. It can also be a release candidate version like 0.20.0rc3, or a rolling release version like 5.0.0-pre.20210317.1.
  • A floating version identifier like 4.x that returns the latest release from the LTS series started by Bazel 4.0.0.
  • The hash of a Git commit. Please note that Bazel binaries are only available for commits that passed Bazel CI.

Additionally, a few special version names are supported for our official releases only (these formats do not work when using a fork):

  • last_green refers to the Bazel binary that was built at the most recent commit that passed Bazel CI. Ideally this binary should be very close to Bazel-at-head.
  • last_rc points to the most recent release candidate. If there is no active release candidate, Bazelisk uses the latest Bazel release instead.
  • rolling refers to the latest rolling release (even if there is a newer LTS release).

Note: last_downstream_green support has been removed, please use last_green instead.

Where does Bazelisk get Bazel from?

By default Bazelisk retrieves Bazel releases, release candidates and binaries built at green commits from Google Cloud Storage. The downloaded artifacts are validated against the SHA256 value recorded in BAZELISK_VERIFY_SHA256 if this variable is set in the configuration file.

As mentioned in the previous section, the <FORK>/<VERSION> version format allows you to use your own Bazel fork hosted on GitHub:

If you want to create a fork with your own releases, you should follow the naming conventions that we use in bazelbuild/bazel for the binary file names as this results in predictable URLs that are similar to the official ones. The URL format looks like https://github.com/<FORK>/bazel/releases/download/<VERSION>/<FILENAME>.

You can also override the URL by setting the environment variable $BAZELISK_BASE_URL. Bazelisk will then append /<VERSION>/<FILENAME> to the base URL instead of using the official release server. Bazelisk will read file ~/.netrc for credentials for Basic authentication.

If for any reason none of this works, you can also override the URL format altogether by setting the environment variable $BAZELISK_FORMAT_URL. This variable takes a format-like string with placeholders and performs the following replacements to compute the download URL:

  • %e: Extension suffix, such as the empty string or .exe.
  • %h: Value of BAZELISK_VERIFY_SHA256, respecting uppercase/lowercase characters.
  • %m: Machine architecture name, such as arm64 or x86_64.
  • %o: Operating system name, such as darwin or linux.
  • %v: Bazel version as determined by Bazelisk.
  • %%: Literal % for escaping purposes.
  • All other characters after % are reserved for future use and result in a processing error.

Environment variables set by Bazelisk

Bazelisk prepends a directory to PATH that contains the downloaded Bazel binary. This ensures that Bazel targets that invoke bazel will use the same Bazel binary as the outer invocation.

Bazelisk also sets the environment variable BAZELISK to its own path. This can be useful for scripts that want to know if they are running under Bazelisk and can also be used to run specific Bazel versions from within a Bazel run, e.g. to generate version-specific test data.

Ensuring that your developers use Bazelisk rather than Bazel

Bazel installers typically provide Bazel's shell wrapper script as the bazel on the PATH.

When installed this way, Bazel checks the .bazelversion file itself, but the failure when it mismatches with the actual version of Bazel can be quite confusing to developers. You may find yourself having to explain the difference between Bazel and Bazelisk (especially when you upgrade the pinned version). To avoid this, you can add a check in your tools/bazel wrapper. Since Bazelisk is careful to avoid calling itself in a loop, it always calls the wrapper with the environment variable BAZELISK_SKIP_WRAPPER set to `true'. You can check for the presence of that variable, and when not found, report a useful error to your users about how to install Bazelisk.

Note that if users directly downloaded a Bazel binary and put it in their PATH, rather than running an installer, then tools/bazel and .bazelversion are not checked. You could call the versions.check starlark module from the beginning of your WORKSPACE to require users update their bazel.

Other features

The Go version of Bazelisk offers three new flags.

--strict

--strict expands to the set of incompatible flags which may be enabled for the given version of Bazel.

bazelisk --strict build //...

--migrate

--migrate will run Bazel multiple times to help you identify compatibility issues. If the code fails with --strict, the flag --migrate will run Bazel with each one of the flag separately, and print a report at the end. This will show you which flags can safely enabled, and which flags require a migration.

--bisect

--bisect flag allows you to bisect Bazel versions to find which version introduced a build failure. You can specify the range of versions to bisect with --bisect=<GOOD>..<BAD>, where GOOD is the last known working Bazel version and BAD is the first known non-working Bazel version. Bazelisk uses GitHub's compare API to get the list of commits to bisect. When GOOD is not an ancestor of BAD, GOOD is reset to their merge base commit. The meaning of GOOD and BAD can be reversed by prefixing the range with ~, e.g. --bisect=~6.0.0..HEAD will find the first version 6.0.0 and HEAD that fixes the build.

Examples:

# Bisect between 6.0.0 and Bazel at HEAD to find the first commit that breaks the build.
bazelisk --bisect=6.0.0..HEAD test //foo:bar_test

# Bisect between 6.1.0 and the second release candidate of Bazel 6.2.0
bazelisk --bisect=6.1.0..release-6.2.0rc2 test //foo:bar_test

# Bisect between two commits on the main branch (or branches with `release-` prefix) of the Bazel GitHub repository.
bazelisk --bisect=<good commit hash>..<bad commit hash> test //foo:bar_test

# Bisect between 6.0.0 and Bazel at HEAD to find the first commit that *fixes* the build.
bazelisk --bisect=~6.0.0..HEAD test //foo:bar_test

Note that, Bazelisk uses prebuilt Bazel binaries at commits on the main and release branches, therefore you cannot bisect your local commits.

Useful environment variables for --migrate and --bisect

You can set BAZELISK_INCOMPATIBLE_FLAGS to set a list of incompatible flags (separated by ,) to be tested, otherwise Bazelisk tests all flags starting with --incompatible_.

You can set BAZELISK_GITHUB_TOKEN to set a GitHub access token to use for API requests to avoid rate limiting when on shared networks.

You can set BAZELISK_SHUTDOWN to run shutdown between builds when migrating or bisecting if you suspect this affects your results.

You can set BAZELISK_CLEAN to run clean --expunge between builds when migrating or bisecting if you suspect this affects your results.

tools/bazel

If tools/bazel exists in your workspace root and is executable, Bazelisk will run this file, instead of the Bazel version it downloaded. It will set the environment variable BAZEL_REAL to the path of the downloaded Bazel binary. This can be useful, if you have a wrapper script that e.g. ensures that environment variables are set to known good values. This behavior can be disabled by setting the environment variable BAZELISK_SKIP_WRAPPER to any value (except the empty string) before launching Bazelisk.

You can control the user agent that Bazelisk sends in all HTTP requests by setting BAZELISK_USER_AGENT to the desired value.

.bazeliskrc configuration file

The Go version supports a .bazeliskrc file in the root directory of a workspace and the user home directory. This file allows users to set environment variables persistently.

Example file content:

USE_BAZEL_VERSION=0.19.0
BAZELISK_GITHUB_TOKEN=abc

The following variables can be set:

  • BAZELISK_BASE_URL
  • BAZELISK_FORMAT_URL
  • BAZELISK_NOJDK
  • BAZELISK_CLEAN
  • BAZELISK_GITHUB_TOKEN
  • BAZELISK_HOME_DARWIN
  • BAZELISK_HOME_LINUX
  • BAZELISK_HOME_WINDOWS
  • BAZELISK_HOME
  • BAZELISK_INCOMPATIBLE_FLAGS
  • BAZELISK_SHOW_PROGRESS
  • BAZELISK_SHUTDOWN
  • BAZELISK_SKIP_WRAPPER
  • BAZELISK_USER_AGENT
  • BAZELISK_VERIFY_SHA256
  • USE_BAZEL_VERSION

Configuration variables are evaluated with precedence order. The preferred values are derived in order from highest to lowest precedence as follows:

  • Variables defined in the environment
  • Variables defined in the workspace root .bazeliskrc
  • Variables defined in the user home .bazeliskrc

Additionally, the Bazelisk home directory is also evaluated in precedence order. The preferred value is OS-specific e.g. BAZELISK_HOME_LINUX, then we fall back to BAZELISK_HOME.

Requirements

For ease of use, the Python version of Bazelisk is written to work with Python 2.7 and 3.x and only uses modules provided by the standard library.

The Go version can be compiled to run natively on Linux, macOS and Windows.

To install it, run:

go install github.com/bazelbuild/bazelisk@latest

To add it to your PATH:

export PATH=$PATH:$(go env GOPATH)/bin

For more information, you may read about the GOPATH environment variable.

Ideas for the future

  • Add support for checked-in Bazel binaries.
  • When the version label is set to a commit hash, first download a matching binary version of Bazel, then build Bazel automatically at that commit and use the resulting binary.

FAQ

Where does Bazelisk store the downloaded versions of Bazel?

It creates a directory called "bazelisk" inside your user cache directory and will store them there. Feel free to delete this directory at any time, as it can be regenerated automatically when required.