Skip to content

docs: add Bazel build guide and bzlmod example - #13

Merged
zchuango merged 1 commit into
LinQuickDev:docs-bazelfrom
cw20050111-prog:2991
Aug 20, 2026
Merged

docs: add Bazel build guide and bzlmod example#13
zchuango merged 1 commit into
LinQuickDev:docs-bazelfrom
cw20050111-prog:2991

Conversation

@cw20050111-prog

@cw20050111-prog cw20050111-prog commented Aug 20, 2026

Copy link
Copy Markdown

What problem does this PR solve?

Issue Number: resolve apache#2991

Problem Summary:

The build documentation currently focuses on config_brpc.sh and CMake. It does not provide a clear Bazel/bzlmod build path for users who want to build bRPC or use bRPC as a Bazel dependency.

What is changed and the side effects?

Changed:

  • Add Bazel/bzlmod build instructions to the English and Chinese getting started docs.
  • Rewrite the English and Chinese Bazel support docs with bzlmod-first dependency guidance.
  • Document the required registries and root MODULE.bazel setup for using bRPC as a Bazel dependency.
  • Add an echo client target to example/build_with_bazel_module so the bzlmod example has both server and client targets.
  • Add required leveldb and openssl single_version_override entries for aarch64 bzlmod builds, and document that users must repeat these overrides in their own root MODULE.bazel.

Side effects:

  • Performance effects: None. This PR only changes documentation and the Bazel example.

  • Breaking backward compatibility: None.

Validation:

  • GitHub Actions passed on PR docs: add Bazel build guide and bzlmod example #13.
  • Linux x64: Bazel all-options jobs passed with both gcc and clang, including the external bzlmod example under example/build_with_bazel_module.
  • macOS ARM64: Bazel build passed.
  • Linux aarch64: manually verified with cd example/build_with_bazel_module && bazel-7.2.1 $JVMARG build //:echo_c++_server //:echo_c++_client.

Check List:

@cw20050111-prog
cw20050111-prog changed the base branch from master to docs-bazel August 20, 2026 08:51
@zchuango
zchuango merged commit 55da905 into LinQuickDev:docs-bazel Aug 20, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

官方文档建议增加bazel的编译介绍,目前只有cmake和config_brpc.sh的步骤

2 participants