Protobuf and gRPC rules for Bazel

Bazel rules for building Protobuf and gRPC code and libraries from proto_library targets

Latest Release Buildkite Status GitHub Actions Status Slack Channel

Overview

These rules provide a consistent set of Protocol Buffers (Protobuf) and gRPC Bazel rules for a wide range of supported languages, services and tools. This aims to encompass all aspects of working with .proto files, such as:

  • Generation of language specific source files with protoc

  • Creation of libraries from protoc source file outputs

  • Linting and checking for breaking changes with Buf

  • Producing documentation from your Protobuf definitions with protoc-gen-doc

Each supported language (shown as {lang} below) is generally split into four rule types:

  • {lang}_proto_compile: Provides generated files from the Protobuf protoc plugin for the language. For example, for C++ this provides the generated *.pb.cc and *.pb.h files.

  • {lang}_proto_library: Provides a language-specific library from the generated Protobuf protoc plugin outputs, along with necessary dependencies. For example, for C++ this provides a Bazel native cpp_library created from the generated *.pb.cc and *.pb.h files, with the Protobuf library linked.

  • {lang}_grpc_compile: Provides generated files from both the Protobuf and gRPC protoc plugins for the language. For example, for C++ this provides the generated *.pb.cc, *.grpc.pb.cc, *.pb.h and *.grpc.pb.h files.

  • {lang}_grpc_library: Provides a language-specific library from the generated Protobuf and gRPC protoc plugins outputs, along with necessary dependencies. For example, for C++ this provides a Bazel native cpp_library created from the generated *.pb.cc, *.grpc.pb.cc, *.pb.h and *.grpc.pb.h files, with the Protobuf and gRPC libraries linked.

Some languages may have variations on these rules, such as when there are multiple gRPC or Protobuf implementations. However, generally you’ll want to use the {lang}_{proto|grpc}_library rules, since these bundle up all the outputs into a library that can easily be used elsewhere in your Bazel workspace. Alternatively, if you just want the generated source code files, you can use the {lang}_{proto|grpc}_compile rules instead.

If you just need compilation of .proto files for a single language, you may find your language specific Bazel rules have their own Protobuf or gRPC rules, which may be preferrable in a single-language repo.

Installation

Add rules_proto_grpc to your WORKSPACE file as shown below and then look at the language specific examples linked in the docs. It is recommended that you use the tagged releases for stable rules. Master is intended to be ‘ready-to-use’, but may be unstable at certain periods. To be notified of new releases, you can use GitHub’s ‘Watch Releases Only’ on the repository.

Note

You will also need to follow instructions in the language-specific pages for additional workspace dependencies that may be required.

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_proto_grpc",
    sha256 = "bbe4db93499f5c9414926e46f9e35016999a4e9f6e3522482d3760dc61011070",
    strip_prefix = "rules_proto_grpc-4.2.0",
    urls = ["https://github.com/rules-proto-grpc/rules_proto_grpc/archive/4.2.0.tar.gz"],
)

load("@rules_proto_grpc//:repositories.bzl", "rules_proto_grpc_toolchains", "rules_proto_grpc_repos")
rules_proto_grpc_toolchains()
rules_proto_grpc_repos()

load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
rules_proto_dependencies()
rules_proto_toolchains()

Supported Languages and Tools

Supported Languages

Language

Protobuf

gRPC

Android

C

C++

C#

D

F#

Go

Java

JavaScript

Objective-C

PHP

Python

Ruby

Rust

Scala

Swift

TypeScript

Supported Tools

Buf Linting

Checks .proto files for common errors and adherance to style guidelines

Buf Breaking Change Detection

Checks .proto files for changes to messages that would break existing clients

grpc-gateway

Produces source files for creating gRPC to JSON proxies

protoc-gen-doc

Creates Markdown, JSON, HTML or DocBook documentation files from your .proto files