Bazel仓库规则如何正确配置依赖实现文件变更触发重跑
仓库规则依赖变更自动触发的实现方法
失效原因
当前实现存在两个核心问题,导致修改filegroup内的文件不会触发规则重跑:
- 给
_tool_deps3设置了allow_single_file = True,这个属性会限制Bazel只能跟踪单个文件节点,当传入filegroup这类集合型目标时,Bazel不会递归展开内部的文件列表 - 规则实现函数里从来没有访问过
_tool_deps2、_tool_deps3这两个属性,仓库规则的依赖跟踪机制只会对实现过程中通过ctx接口访问到的文件建立关联,没被访问的属性不会参与变更检测
具体修改步骤
1. 调整规则的属性定义
把原来的单文件限制去掉,改成支持多文件跟踪的配置:
# 替换原来的错误属性定义 "_tool_deps3": attr.label( # 移除allow_single_file,允许传入多文件集合目标 allow_files = True, # 声明该属性关联的所有文件都是规则的编译时输入,变更会触发重跑 flags = ["DIRECTORY_COMPILE_TIME_INPUT"], )
2. 在规则实现中显式注册文件依赖
在_irule_impl函数开头增加依赖遍历逻辑,哪怕你不需要直接使用这些文件的内容,只要通过ctx.files拿到文件列表,就会自动让Bazel建立变更跟踪:
def _irule_impl(ctx): # 遍历单文件依赖,触发跟踪注册 for f in ctx.files._tool_deps2: _ = f.path # 遍历filegroup下的所有展开文件,触发跟踪注册 for f in ctx.files._tool_deps3: _ = f.path # 以下是原有业务逻辑 cmd = [ str(ctx.path(ctx.attr._tool)) ] st = ctx.execute(cmd, environment = ctx.os.environ) ctx.symlink(st.stdout,"my_r2") ctx.execute(["echo",">>>>>>>>>>>>>>>>>>>>>>>>> Running implementation"], quiet=False)
关键注意点
ctx.files.<属性名>会自动递归展开filegroup嵌套的所有子文件,不需要手动遍历嵌套结构,所有层级的文件变更都会被纳入缓存键计算- 不要用
ctx.path()处理多文件类型的label,这个接口仅适用于单文件目标,对集合目标的返回值不具备可靠的跟踪能力 - 修改完成后需要先执行
bazel clean --expunge清空旧的仓库缓存,再重新构建,否则Bazel会沿用旧版本的依赖跟踪记录,无法识别新增的文件关联
内容的提问来源于stack exchange,提问作者Koen Van Hoof
相关产品推荐
相关产品推荐

