Skip to content

Commit

Permalink
Update incompatible metadataTags and explain the incompatible-change …
Browse files Browse the repository at this point in the history
…flag.

TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES was removed, see bazelbuild/bazel#13892
  • Loading branch information
tetromino committed Nov 11, 2021
1 parent bd63842 commit 2e64a9c
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions maintaining/breaking-changes-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ We recommend that:
`incompatible_`).

* You add the label [`incompatible-change`](https://github.com/bazelbuild/bazel/labels/incompatible-change).
This ensures that the flag, once it's merged, will be picked up by the
[`bazelisk-plus-incompatible-flags` pipeline](https://buildkite.com/bazel/bazelisk-plus-incompatible-flags).

* The description contains a description of the change and a link to relevant
design documents.
Expand All @@ -61,13 +63,10 @@ also report warnings.

Create a new flag in Bazel. The default value must be false. The help text
should contain the URL of the GitHub issue. As the flag name starts with
`incompatible_`, it needs metadata tags:
`incompatible_`, it needs a metadata tag:

```java
metadataTags = {
OptionMetadataTag.INCOMPATIBLE_CHANGE,
OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES
},
metadataTags = {OptionMetadataTag.INCOMPATIBLE_CHANGE},
```

In the commit description, add a brief summary of the flag.
Expand Down

0 comments on commit 2e64a9c

Please sign in to comment.