chore: mirror protoc release (#2)

1 file changed
tree: 816757f2ac226340b28c92e505a4ecdbc9938724
  1. .bcr/
  2. .devcontainer/
  3. .github/
  4. e2e/
  5. examples/
  6. protoc/
  7. .bazelignore
  8. .bazelrc
  9. .bazelversion
  10. .gitignore
  11. .pre-commit-config.yaml
  12. .prettierignore
  13. BUILD.bazel
  14. CONTRIBUTING.md
  15. LICENSE
  16. MODULE.bazel
  17. README.md
  18. renovate.json
  19. WORKSPACE.bazel
README.md

Bazel toolchain for pre-built protoc

Using Protocol Buffers with Bazel has always been painful.

  • Nearly every Bazel user has waited for protoc to compile from sources many, MANY times.
  • The versioning of the protobuf module on Bazel Central Registry has fallen behind and contains many patches.
  • Relying on the protobuf runtime for each language from the @com_google_protobuf repo forces you to use the same version of the runtime for all languages in a monorepo, and matching protoc.

The key observations:

Bazel 7 introduced --incompatible_enable_proto_toolchain_resolution to allow us fetch protoc rather than re-build it! That flag ALSO decouples how each language rule locates the runtime.

This repo simply contains a toolchain that resolves those pre-built binaries.

See examples for several language rules like py_proto_library and java_proto_library. There is NO dependency on @com_google_protobuf anywhere.

Design

Questioning why Bazel is different

Protobuf works fine under many build tools, using the releases and runtime libraries shipped by the protobuf team. Why is Bazel different?

Our answer is: it should not be. The protobuf team shouldn’t have to own Bazel rules or understand bzlmod. As with many other tools such as Swagger and GraphQL, the Bazel community is self-sufficient to create thin layers to establish a toolchain and execute actions that perform codegen steps.

This toolchain shows that there's no need to treat Bazel as a “special” build system vs. all the others that protobuf users rely on. https://protobuf.dev/reference/ is sufficient documentation for everyone.

Why a separate Bazel module?

This belongs in rules_proto, see

Getting reviews from Googlers is hard so let's not wait for them.

Installation

Make sure your .bazelrc contains

# Introduced in Bazel 7.
common --incompatible_enable_proto_toolchain_resolution

Follow instructions from the release you wish to use: https://github.com/alexeagle/toolchains_protoc/releases