Bazel技术问题：如何在Skylark中访问工作区状态变量？

我来帮你梳理下如何实现这个需求——把通过--workspace_status_command输出的STABLE_*变量暴露给自定义Starlark规则，这和Kubernetes test-infra里的用法思路完全一致。

1. 编写Workspace状态脚本 #

首先你需要一个可执行脚本（比如status.sh），用来输出你的STABLE_*变量，格式必须是KEY VALUE，其中KEY以STABLE_开头才能被标记为稳定状态变量（不会触发不必要的重新构建）。

示例脚本：

#!/bin/bash
# 输出稳定版本号
echo "STABLE_BUILD_VERSION v1.2.3"
# 输出Git提交哈希（需要环境中有Git）
echo "STABLE_GIT_COMMIT $(git rev-parse HEAD)"
# 自定义构建环境变量
echo "STABLE_BUILD_ENV production"

记得给脚本添加执行权限：chmod +x status.sh

2. 在自定义Starlark规则中访问变量 #

Bazel会自动把STABLE_*变量注入到规则上下文的ctx.var字典中，注意变量名会自动去掉STABLE_前缀。比如脚本里的STABLE_BUILD_VERSION，在规则中要通过ctx.var["BUILD_VERSION"]访问。

示例规则文件my_rules.bzl：

def _my_build_info_rule_impl(ctx):
    # 从ctx.var中获取稳定变量，同时提供默认值避免变量缺失时报错
    build_version = ctx.var.get("BUILD_VERSION", "unknown")
    git_commit = ctx.var.get("GIT_COMMIT", "unknown")
    build_env = ctx.var.get("BUILD_ENV", "dev")

    # 示例场景：生成包含构建信息的文件
    ctx.actions.write(
        output = ctx.outputs.info_file,
        content = """
# Generated Build Info
VERSION: {}
GIT_COMMIT: {}
ENVIRONMENT: {}
""".strip().format(build_version, git_commit, build_env)
    )

# 定义自定义规则
my_build_info = rule(
    implementation = _my_build_info_rule_impl,
    outputs = {"info_file": "%{name}.info"},
)

3. 在BUILD文件中使用自定义规则 #

在你的BUILD文件里加载并实例化这个规则：

load("//path/to/your/rules:my_rules.bzl", "my_build_info")

# 创建规则实例
my_build_info(
    name = "app_build_info",
)

4. 构建时指定状态命令 #

运行Bazel构建时，通过--workspace_status_command参数指定你的脚本路径：

bazel build //:app_build_info --workspace_status_command=./status.sh

构建完成后，你就能在bazel-bin/app_build_info.info文件中看到注入的稳定变量值了。

关键注意事项 #

• 稳定变量特性：STABLE_前缀的变量不会触发无意义的重新构建——只有当脚本输出的这些变量值变化时，Bazel才会重新执行相关规则，这对优化大型项目的构建速度很关键。
• 变量名转换：Bazel会自动去掉STABLE_前缀，所以在ctx.var中要用去掉前缀后的名称访问。如果需要保留前缀，你可以不用STABLE_开头，但这样变量会变成非稳定状态，每次构建都会重新生成。
• 容错处理：建议用ctx.var.get("VAR_NAME", "default_value")的方式访问变量，避免因为脚本未输出某个变量导致构建报错。

内容的提问来源于stack exchange，提问作者Gregg