go - 提交 Gazelle 生成的 `BUILD.bazel` 文件是最佳做法吗？

Question

我有一个使用 rules_go 的 Go 项目( Bazel ) 构建项目。我正在使用 Gazelle生成 BUILD.bazel 文件。将生成的 BUILD.bazel 文件提交到版本控制中是否被认为是最佳实践？还是在新结帐时和添加新文件时始终执行 bazel run//:gazelle 是最佳实践？

Answer 1

是的，出于多种原因，提交构建文件通常是最佳做法。

• 构建文件经常包含未生成的规则、注释和注释。例如，您可能需要编写一个 genrule 来替换 go generate。或者您可以编写一个测试来检查源文件中的版权 header 是否是最新的。或者您可能想要调整您的某些图书馆的可见性规则。
• 如果任何存储库依赖于您的存储库作为远程存储库，那么将构建文件 checkin 会很方便。
• 一般来说，在构建之前不必重新运行 Gazelle 和类似工具是件好事。