| #!/usr/bin/env bash |
| # Copyright 2024 The Bazel Authors. All rights reserved. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| set -o errexit -o nounset -o pipefail |
| |
| # Set by GH actions, see |
| # https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables |
| TAG=${GITHUB_REF_NAME} |
| # The prefix is chosen to match what GitHub generates for source archives |
| # This guarantees that users can easily switch from a released artifact to a source archive |
| # with minimal differences in their code (e.g. strip_prefix remains the same) |
| PREFIX="rules_android-${TAG:1}" |
| ARCHIVE="rules_android-$TAG.tar.gz" |
| |
| # NB: configuration for 'git archive' is in /.gitattributes |
| git archive --format=tar --prefix=${PREFIX}/ ${TAG} | gzip > $ARCHIVE |
| SHA=$(shasum -a 256 $ARCHIVE | awk '{print $1}') |
| |
| cat << EOF |
| ## Using Bzlmod with Bazel 6 or greater |
| |
| 1. (Bazel 6 only) Enable with \`common --enable_bzlmod\` in \`.bazelrc\`. |
| 2. Add to your \`MODULE.bazel\` file: |
| |
| \`\`\`starlark |
| # See examples/basicapp/MODULE.bazel. |
| bazel_dep(name = "rules_android", version = "${TAG:1}") |
| 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") |
| \`\`\` |
| |
| ## Using WORKSPACE |
| |
| Paste this snippet into your \`WORKSPACE.bazel\` file: |
| |
| \`\`\`starlark |
| load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") |
| http_archive( |
| name = "rules_android", |
| sha256 = "${SHA}", |
| strip_prefix = "${PREFIX}", |
| url = "https://github.com/bazelbuild/rules_android/releases/download/${TAG}/${ARCHIVE}", |
| ) |
| EOF |
| |
| awk 'f;/--SNIP--/{f=1}' examples/basicapp/WORKSPACE |
| echo "\`\`\`" |
| |
| cat << EOF |
| |
| ## In BUILD |
| |
| Load the rules from \`rules_android\`: |
| |
| \`\`\`starlark |
| load("@rules_android//rules:rules.bzl", "android_binary", "android_library") |
| android_binary( |
| ... |
| ) |
| |
| android_library( |
| ... |
| ) |
| \`\`\` |
| EOF |
| |