Skip to content

Commit d9319a5

Browse files
ted-xiecopybara-github
authored andcommitted
Improve documentation
* Revise the recommended bazel version in README.md * Add a disclaimer in the README for protobuf C++ minimum version * Add more detail to bzlmod rules_android setup in the release notes. PiperOrigin-RevId: 793810183 Change-Id: I6b5fbf3e7c24f7be7d7e87506dfd6b11d86a2d31
1 parent a09c47f commit d9319a5

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

.github/workflows/release_prep.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,17 @@ cat << EOF
3535
2. Add to your \`MODULE.bazel\` file:
3636
3737
\`\`\`starlark
38+
# See examples/basicapp/MODULE.bazel.
3839
bazel_dep(name = "rules_android", version = "${TAG:1}")
40+
remote_android_extensions = use_extension(
41+
"@rules_android//bzlmod_extensions:android_extensions.bzl",
42+
"remote_android_tools_extensions")
43+
use_repo(remote_android_extensions, "android_tools")
44+
45+
android_sdk_repository_extension = use_extension("@rules_android//rules/android_sdk_repository:rule.bzl", "android_sdk_repository_extension")
46+
use_repo(android_sdk_repository_extension, "androidsdk")
47+
48+
register_toolchains("@androidsdk//:sdk-toolchain", "@androidsdk//:all")
3949
\`\`\`
4050
4151
## Using WORKSPACE

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
## Disclaimer
44

5-
NOTE: This branch is a development preview of the Starlark implementation of Android rules for Bazel. This code is incomplete and may not function as-is.
5+
NOTE: This branch is a development preview of the Starlark implementation of
6+
Android rules for Bazel. This code is incomplete and may not function as-is.
67

7-
A version of Bazel built at or near head or a recent pre-release and the following flags are necessary to use these rules:
8+
A recent version of Bazel (7.4+, 8.0+, HEAD, Bazel 9 pre-release) is required.
89

9-
```
10-
--experimental_enable_android_migration_apis
11-
--experimental_google_legacy_api
12-
```
10+
This ruleset depends on [Protobuf](https://github.com/protocolbuffers/protobuf),
11+
which has a minimum C++ language level of 17 (as of Protobuf v30, ~2025 Q3).
12+
Depending on your system's compiler version, you may have to set `-std=c++17`
13+
in your C++ toolchain arguments. This repository's .bazelrc file provides a
14+
minimal set of Bazel configuration flags to build an Android app.
1315

1416
## Overview
1517

@@ -94,8 +96,6 @@ use_repo(android_sdk_repository_extension, "androidsdk")
9496
register_toolchains("@androidsdk//:sdk-toolchain", "@androidsdk//:all")
9597
```
9698

97-
98-
9999
Then, in your BUILD files, import and use the rules:
100100

101101
```starlark

0 commit comments

Comments
 (0)