Bazel genrule如何获取工作区根目录绝对路径以执行git生成版本头文件
Bazel genrule 工作目录切换问题解决方案
问题场景
需要通过genrule生成包含当前Git提交哈希的version_info.h头文件,目前执行命令时发现:Windows下PowerShell运行genrule的目录不是Git仓库根(即Bazel工作区根目录),无法正常执行git命令获取提交哈希,需要替换genrule命令行中cd what_comes_here的占位内容,实现先切换到正确工作目录再执行后续命令。
直接可用的替换值
不需要硬编码本地绝对路径,直接使用Bazel内置注入的工作区根目录变量即可,针对不同shell环境分别替换:
- Linux/macOS端bash环境(对应genrule的
cmd字段):将what_comes_here替换为$${BUILD_WORKSPACE_DIRECTORY}
注意变量必须写双美元符号转义:Bazel的命令字符串会先做一次自身的变量解析,单写$会被Bazel当成未定义的内置变量解析为空,双$$才能让变量传递给底层bash解释器,解析为实际的工作区绝对路径。 - Windows端PowerShell环境(对应genrule的
cmd_ps字段):将what_comes_here替换为$env:BUILD_WORKSPACE_DIRECTORY
该环境变量由Bazel在启动执行进程时直接注入到系统环境中,PowerShell可直接读取,指向的路径和bash端的BUILD_WORKSPACE_DIRECTORY完全一致,就是本地的Bazel工作区根目录(同时也是你的Git仓库根目录)。
注意事项
- 原genrule的
cmd字段存在字符串拼接语法错误:原代码里把cd 路径、拼接头文件模板、执行git命令的逻辑拆成了多个独立字符串片段,没有用括号包裹成完整的命令字符串,替换完目录变量后需要把整段bash逻辑合并到同一个引号包裹的字符串里,避免shell解析报错。 BUILD_WORKSPACE_DIRECTORY是Bazel官方约定的内置环境变量,不管构建流程是本地执行还是远端执行,只要是在本地工作区触发的构建,该变量都会被正确注入,不需要额外做路径适配。- 切到正确工作目录后,原代码里的git命令、头文件模板拼接逻辑不需要额外修改,即可正常获取当前提交哈希写入生成的头文件。
内容的提问来源于stack exchange,提问作者matthias_buehlmann
相关产品推荐
相关产品推荐

