This page provides information on how to handle backward compatibility, including migrating from one release to another and how to communicate incompatible changes.
Bazel is evolving. Minor versions released as part of an LTS major version are fully backward-compatible. Changes between major LTS releases may contain incompatible changes that require some migration effort. For more information on how the Bazel release cadence works, see Announcing Bazel Long Term Support (LTS) releases.
--incompatible_*
flags for breaking changes.--incompatible_*
flag, a GitHub issue explains the change in behavior and aims to provide a migration recipe.--experimental_*
flag can change at any time.--experimental_*
or --incompatible_*
flags.In general, APIs or behaviors without --experimental_...
flags are considered stable, supported features in Bazel.
This includes:
For every incompatible change in a new release, the Bazel team aims to provide a migration recipe that helps you update your code (BUILD
and .bzl
files, as well as any Bazel usage in scripts, usage of Bazel API, and so on).
Incompatible changes should have an associated --incompatible_*
flag and a corresponding GitHub issue.
The primary source of information about incompatible changes are GitHub issues marked with an “incompatible-change” label.
For every incompatible change, the issue specifies the following:
The incompatible change issue is closed when the incompatible flag is flipped at HEAD. All incompatible changes that are expected to happen in release X.Y are marked with a label “breaking-change-X.Y”."