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