Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider renaming BUILD -> BUILD.bazel #7720

Closed
devjgm opened this issue Dec 9, 2021 · 0 comments · Fixed by #7722
Closed

Consider renaming BUILD -> BUILD.bazel #7720

devjgm opened this issue Dec 9, 2021 · 0 comments · Fixed by #7722
Assignees
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@devjgm
Copy link
Contributor

devjgm commented Dec 9, 2021

Bazel supports build files named either BUILD or BUILD.bazel. The bazel team doesn't seem to make an explicit recommendation, but this issue bazelbuild/bazel#4517 seems to show that some of the community recommends the more explicit BUILD.bazel naming.

We might want to consider renaming our build files to BUILD.bazel. This could also be an advantage when this code is used in an environment where blaze BUILD files are also needed. 😉

@devjgm devjgm added the type: cleanup An internal cleanup or hygiene concern. label Dec 9, 2021
@devjgm devjgm self-assigned this Dec 9, 2021
devjgm added a commit that referenced this issue Dec 10, 2021
Fixes: #7720

Bazel supports `BUILD` and `BUILD.bazel`. The latter seems to be preferable because it's less likely to conflict with something else, and it will make our imports a bit easier. I also changed `WORKSPACE` -> `WORKSPACE.bazel`. 

This change should be transparent to our users.

NOTES: 
* There are still generic uses of the term "BUILD" file. This is common in bazel's docs, and I think it's fine in ours as well. That is, we can still say "update the BUILD file", and it means to update whichever bazel build file you have (either `BUILD` or `BUILD.bazel`). There were a few places where we referred to a _specific_ file, and in those cases I updated the documentation.
* We still have some `bazel/*.BUILD` files. I left these because they already have specific names. We _could_ rename them to something like `foo.BUILD.bazel` or `foo.bazel` instead, but that didn't seem much clearer.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant