diff options
| author | Yifan Hong <elsk@google.com> | 2024-03-04 17:52:07 -0800 |
|---|---|---|
| committer | Yifan Hong <elsk@google.com> | 2024-03-06 18:47:30 +0000 |
| commit | 65fc1eef78eb0cd27e2c9eddbe3a7ef50e073b40 (patch) | |
| tree | b5e5cad69ea8c1f0b29c26fc371dc22087ac1674 | |
| parent | bf4e4c857547eb458b16f88b0e2fe87af1178029 (diff) | |
| download | build-65fc1eef78eb0cd27e2c9eddbe3a7ef50e073b40.tar.gz | |
kleaf: Mark legacy WORKSPACE as deprecated.
Encourage users to switch over to bzlmod, as announced
in the GKI newsletter.
Bug: 276493276
Change-Id: I886cd7fb7b4028015e8cb4172de3718e9eede5c3
| -rw-r--r-- | kleaf/docs/api_reference/workspace.md | 5 | ||||
| -rw-r--r-- | kleaf/workspace.bzl | 10 |
2 files changed, 15 insertions, 0 deletions
diff --git a/kleaf/docs/api_reference/workspace.md b/kleaf/docs/api_reference/workspace.md index 1ace794..0c15fe6 100644 --- a/kleaf/docs/api_reference/workspace.md +++ b/kleaf/docs/api_reference/workspace.md @@ -28,4 +28,9 @@ called, it must be called after `define_kleaf_workspace` is called. | <a id="define_kleaf_workspace-include_remote_java_tools_repo"></a>include_remote_java_tools_repo | Default is `False`. Whether to vendor two extra repositories: remote_java_tools and remote_java_tools_linux.<br><br>These respositories should exist under `//prebuilts/bazel/` | `False` | | <a id="define_kleaf_workspace-artifact_url_fmt"></a>artifact_url_fmt | API endpoint for Android CI artifacts. The format may include anchors for the following properties: * {build_number} * {target} * {filename} | `None` | +**DEPRECATED** + +The use of legacy WORKSPACE is deprecated. Please migrate to Bazel modules. +See [bzlmod.md](../bzlmod.md). + diff --git a/kleaf/workspace.bzl b/kleaf/workspace.bzl index f215cf0..f262bc0 100644 --- a/kleaf/workspace.bzl +++ b/kleaf/workspace.bzl @@ -64,8 +64,18 @@ def define_kleaf_workspace( * {build_number} * {target} * {filename} + + Deprecated: + The use of legacy WORKSPACE is deprecated. Please migrate to Bazel modules. + See [bzlmod.md](../bzlmod.md). """ + # buildifier: disable=print + print(""" +WARNING: The use of legacy WORKSPACE is deprecated. Please migrate to Bazel modules. + For details, see build/kernel/kleaf/docs/bzlmod.md. +""") + if common_kernel_package == None: common_kernel_package = str(Label("//common:x")).removesuffix(":x") if not common_kernel_package.startswith("@") and not common_kernel_package.startswith("//"): |