xref: /aosp_15_r20/external/grpc-grpc/doc/bazel_support.md (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker# Bazel Support
2*cc02d7e2SAndroid Build Coastguard Worker
3*cc02d7e2SAndroid Build Coastguard Worker## Basic Usage
4*cc02d7e2SAndroid Build Coastguard Worker
5*cc02d7e2SAndroid Build Coastguard WorkerThe `grpc/grpc` repository's primary build system is Bazel. Rules are provided
6*cc02d7e2SAndroid Build Coastguard Workerfor C++, Python, and Objective-C. While C++ supports other build systems such as
7*cc02d7e2SAndroid Build Coastguard WorkerCMake, these rules are actually generated from the Bazel definitions.
8*cc02d7e2SAndroid Build Coastguard Worker
9*cc02d7e2SAndroid Build Coastguard WorkerProjects built with Bazel may use the `grpc/grpc` repo not only to add a
10*cc02d7e2SAndroid Build Coastguard Workerdependency on the library itself, but also to generate protobuf, stub, and
11*cc02d7e2SAndroid Build Coastguard Workerservicer code. To do so, one must invoke the `grpc_deps` and `grpc_extra_deps`
12*cc02d7e2SAndroid Build Coastguard Workerrepository rules in their `WORKSPACE` file:
13*cc02d7e2SAndroid Build Coastguard Worker
14*cc02d7e2SAndroid Build Coastguard Worker```starlark
15*cc02d7e2SAndroid Build Coastguard Workerworkspace(name = "example_workspace")
16*cc02d7e2SAndroid Build Coastguard Worker
17*cc02d7e2SAndroid Build Coastguard Workerload("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
18*cc02d7e2SAndroid Build Coastguard Worker
19*cc02d7e2SAndroid Build Coastguard Workerhttp_archive(
20*cc02d7e2SAndroid Build Coastguard Worker    name = "com_github_grpc_grpc",
21*cc02d7e2SAndroid Build Coastguard Worker    strip_prefix = "grpc-1.45.0",
22*cc02d7e2SAndroid Build Coastguard Worker    sha256 = "ec19657a677d49af59aa806ec299c070c882986c9fcc022b1c22c2a3caf01bcd",
23*cc02d7e2SAndroid Build Coastguard Worker    urls = ["https://github.com/grpc/grpc/archive/refs/tags/v1.45.0.tar.gz"],
24*cc02d7e2SAndroid Build Coastguard Worker)
25*cc02d7e2SAndroid Build Coastguard Worker
26*cc02d7e2SAndroid Build Coastguard Workerload("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
27*cc02d7e2SAndroid Build Coastguard Worker
28*cc02d7e2SAndroid Build Coastguard Workergrpc_deps()
29*cc02d7e2SAndroid Build Coastguard Worker
30*cc02d7e2SAndroid Build Coastguard Workerload("@com_github_grpc_grpc//bazel:grpc_extra_deps.bzl", "grpc_extra_deps")
31*cc02d7e2SAndroid Build Coastguard Worker
32*cc02d7e2SAndroid Build Coastguard Workergrpc_extra_deps()
33*cc02d7e2SAndroid Build Coastguard Worker```
34*cc02d7e2SAndroid Build Coastguard Worker
35*cc02d7e2SAndroid Build Coastguard Worker## Supported Versions
36*cc02d7e2SAndroid Build Coastguard Worker
37*cc02d7e2SAndroid Build Coastguard WorkergRPC supports building with the latest stable release of Bazel,
38*cc02d7e2SAndroid Build Coastguard Workeras well as the previous major version release for at least 6 months
39*cc02d7e2SAndroid Build Coastguard Workerafter it transitions into maintenance mode.
40*cc02d7e2SAndroid Build Coastguard WorkerThis is consistent with the supported build systems of
41*cc02d7e2SAndroid Build Coastguard Worker[the Google Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support).
42*cc02d7e2SAndroid Build Coastguard WorkerHowever individual releases may have a broader
43*cc02d7e2SAndroid Build Coastguard Workercompatibility range. The currently supported versions are captured by the
44*cc02d7e2SAndroid Build Coastguard Workerfollowing list:
45*cc02d7e2SAndroid Build Coastguard Worker
46*cc02d7e2SAndroid Build Coastguard Worker- [`7.1.0`](https://github.com/bazelbuild/bazel/releases/tag/7.1.0)
47*cc02d7e2SAndroid Build Coastguard Worker- [`6.5.0`](https://github.com/bazelbuild/bazel/releases/tag/6.5.0)
48*cc02d7e2SAndroid Build Coastguard Worker
49*cc02d7e2SAndroid Build Coastguard WorkerNOTE: gRPC doesn't support bzlmod yet.