rules_android

module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 6, 2026 License: Apache-2.0

README

Android support in Bazel

Disclaimer

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.

A recent version of Bazel (7.4+, 8.0+, HEAD, Bazel 9 pre-release) is required.

This ruleset depends on Protobuf, which has a minimum C++ language level of 17 (as of Protobuf v30, ~2025 Q3). Depending on your system's compiler version, you may have to set -std=c++17 in your C++ toolchain arguments. This repository's .bazelrc file provides a minimal set of Bazel configuration flags to build an Android app.

Overview

This repository contains the Starlark implementation of Android rules in Bazel.

The rules are being incrementally converted from their native implementations in the Bazel source tree.

Stardoc for the Android rules can be found at https://bazelbuild.github.io/rules_android.

Getting Started

To use the Starlark Bazel Android rules, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "rules_android",
    sha256 = "fe3d8c4955857b44019d83d05a0b15c2a0330a6a0aab990575bb397e9570ff1b",
    strip_prefix = "rules_android-0.6.0-alpha1",
    url = "https://github.com/bazelbuild/rules_android/releases/download/v0.6.0-alpha1/rules_android-v0.6.0-alpha1.tar.gz",
)

# Android rules dependencies
load("@rules_android//:prereqs.bzl", "rules_android_prereqs")
rules_android_prereqs()

##### rules_java setup for rules_android #####
load("@rules_java//java:rules_java_deps.bzl", "rules_java_dependencies")
rules_java_dependencies()
# note that the following line is what is minimally required from protobuf for the java rules
# consider using the protobuf_deps() public API from @com_google_protobuf//:protobuf_deps.bzl
load("@com_google_protobuf//bazel/private:proto_bazel_features.bzl", "proto_bazel_features")  # buildifier: disable=bzl-visibility
proto_bazel_features(name = "proto_bazel_features")
# register toolchains
load("@rules_java//java:repositories.bzl", "rules_java_toolchains")
rules_java_toolchains()

##### rules_jvm_external setup for rules_android #####
load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")
rules_jvm_external_deps()
load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")
rules_jvm_external_setup()

##### rules_android setup #####
load("@rules_android//:defs.bzl", "rules_android_workspace")
rules_android_workspace()

# Android SDK setup
load("@rules_android//rules:rules.bzl", "android_sdk_repository")
android_sdk_repository(
    name = "androidsdk",
)

register_toolchains(
    "@rules_android//toolchains/android:android_default_toolchain",
    "@rules_android//toolchains/android_sdk:android_sdk_tools",
)

Or, if you want to use bzlmod, add the following to your MODULE.bazel file:

MODULE.bazel:

bazel_dep(name = "rules_java", version = "7.11.1")
bazel_dep(name = "bazel_skylib", version = "1.3.0")

bazel_dep(name = "rules_android", version = "0.6.5")

remote_android_extensions = use_extension(
    "@rules_android//bzlmod_extensions:android_extensions.bzl",
    "remote_android_tools_extensions")
use_repo(remote_android_extensions, "android_tools")

android_sdk_repository_extension = use_extension("@rules_android//rules/android_sdk_repository:rule.bzl", "android_sdk_repository_extension")
use_repo(android_sdk_repository_extension, "androidsdk")

register_toolchains("@androidsdk//:sdk-toolchain", "@androidsdk//:all")

Then, in your BUILD files, import and use the rules:

load("@rules_android//rules:rules.bzl", "android_binary", "android_library")
android_binary(
    ...
)

android_library(
   ...
)

Directories

Path Synopsis
src
tools/ak/res
Package res handles understanding and representing information about Android resources.
Package res handles understanding and representing information about Android resources.
tools/ak/res/respipe
Package respipe contains utilities for running pipelines on android resources.
Package respipe contains utilities for running pipelines on android resources.
tools/ak/res/resxml
Package resxml contains common functions to extract information from xml files and feed that information into the resource processing pipeline.
Package resxml contains common functions to extract information from xml files and feed that information into the resource processing pipeline.
tools/bundletool_module_builder command
Tool for building Bundletool modules for apps and SDKs.
Tool for building Bundletool modules for apps and SDKs.
tools/deploy_info command
Tool to generate the deploy_info.pb that ASwB needs in order to deploy apps.
Tool to generate the deploy_info.pb that ASwB needs in order to deploy apps.
tools/extract_desugar_pgcfg_flags command
Tool for extracting the shrinker_config field from desugar_jdk_libs's json config file.
Tool for extracting the shrinker_config field from desugar_jdk_libs's json config file.
tools/jar_to_module_info command
Creates a module-info.java that exports all packages in the provided .jar file; see README.md
Creates a module-info.java that exports all packages in the provided .jar file; see README.md
tools/jdeps command
jdeps is a command line tool to filter a jdeps proto
jdeps is a command line tool to filter a jdeps proto
tools/split_core_jar command
split_core_jar splits the given jar into a 'core' jar containing packages found in --core_jars, and an 'auxiliary' jar containing the remaining packages
split_core_jar splits the given jar into a 'core' jar containing packages found in --core_jars, and an 'auxiliary' jar containing the remaining packages

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL