Update readme (#90)

Change-Id: Idad5d7b02c977b3951cb9e86565f2dfd64e6ffb0
1 file changed
tree: 8d6f270f7e206fa2594f5b0e2221bfaf99c5a02d
  1. .bazelci/
  2. android/
  3. examples/
  4. kokoro/
  5. mobile_install/
  6. rules/
  7. src/
  8. test/
  9. toolchains/
  10. tools/
  11. .bazelignore
  12. .bazelrc
  13. .gitignore
  14. AUTHORS
  15. BUILD
  16. CONTRIBUTING.md
  17. CONTRIBUTORS
  18. defs.bzl
  19. go.mod
  20. go.sum
  21. groups
  22. LICENSE
  23. MODULE.bazel
  24. prereqs.bzl
  25. project.config
  26. README.md
  27. WORKSPACE
  28. WORKSPACE.bzlmod
README.md

Android support in Bazel

Deprecation notice

The pre-alpha branch of https://github.com/bazelbuild/rules_android is now deprecated. Active development has been moved to the ‘main’ branch. The ‘main’ and ‘pre-alpha’ branches share a commit history until 0ba045398138d641fd8895bb08a6bd4bfa51d0f9 (from May 2023). We will leave this branch up for posterity.

Disclaimer

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

A version of Bazel built at or near head or a recent pre-release and the following flags are necessary to use these rules:

--experimental_enable_android_migration_apis
--experimental_google_legacy_api
--incompatible_java_common_parameters
--android_databinding_use_v3_4_args
--experimental_android_databinding_v2

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.

For the list of Android rules, see the Bazel documentation.

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")

# Or a later commit
RULES_ANDROID_COMMIT= "0bf3093bd011acd35de3c479c8990dd630d552aa"
RULES_ANDROID_SHA = "b75a673a66c157138ab53f4d8612a6e655d38b69bb14207c1a6675f0e10afa61"
http_archive(
    name = "build_bazel_rules_android",
    url = "https://github.com/bazelbuild/rules_android/archive/%s.zip" % RULES_ANDROID_COMMIT,
    sha256 = RULES_ANDROID_SHA,
    strip_prefix = "rules_android-%s" % RULES_ANDROID_COMMIT,
)
load("@build_bazel_rules_android//:prereqs.bzl", "rules_android_prereqs")
rules_android_prereqs()
load("@build_bazel_rules_android//:defs.bzl", "rules_android_workspace")
rules_android_workspace()

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

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

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

android_library(
    ...
)