Bazel: introduce buildifier formatting #16315
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces tooling and enforcement for formatting bazel files. The tooling is provided as a bazel run target from [keith/buildifier-prebuilt](https://github.com/keith/buildifier-prebuilt). This is used in a [`pre-commit`](https://pre-commit.com/) hook for those having that installed. In turn this is used in a CI check. Relying on a `pre-commit` action gives us easy checking that buildifying did not change anything in the files and printing the diff, without having to hand-roll the check ourselves. This enforcement will make usage of gazelle easier, as gazelle itself might reformat files, even outside of `go`. Having them properly formatted will allow gazelle to leave them unchanged, without needing to configure awkward exclude directives.
|
Here's an example of a failed check: https://github.com/github/codeql/actions/runs/8818521246/job/24207498592?pr=16316 |
redsun82
force-pushed
the
redsun82/buildifier
branch
from
6244d36 to
9def572
Compare
|
In the end this isn't really required for go, as I ended up restricting gazelle generation. Still think it's a good idea, so I'll go ahead and merge it 🙂 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces tooling and enforcement for formatting bazel files.
The tooling is provided as a bazel run target from keith/buildifier-prebuilt.
This is used in a
pre-commithook for those having that installed. In turn this is used in a CI check. Relying on apre-commitaction gives us easy checking that buildifying did not change anything in the files and printing the diff, without having to hand-roll the check ourselves.