Git 代码库规则

报告问题查看源代码 每夜 build · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

可以从 @bazel_tools//tools/build_defs/repo:git.bzl 加载以下函数。

克隆外部 Git 代码库的规则。

git_repository

load("@bazel//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(name, branch, build_file, build_file_content, commit, init_submodules, patch_args,
               patch_cmds, patch_cmds_win, patch_strip, patch_tool, patches,
               recursive_init_submodules, remote, remote_module_file_integrity,
               remote_module_file_urls, repo_mapping, shallow_since, sparse_checkout_file,
               sparse_checkout_patterns, strip_prefix, tag, verbose, workspace_file,
               workspace_file_content)

克隆外部 Git 代码库。

克隆 Git 代码库，检出指定的标记或提交，并使其目标可供绑定。此外，还要确定实际签出的提交 ID 及其日期，并返回一个字典，其中包含提供此规则可重现版本的参数（代码可能不包含此类参数）。

Bazel 会先尝试仅浅提取指定提交。如果该操作失败（通常是因为缺少服务器支持），则会回退到对代码库进行完整提取。

首选 http_archive，而不是 git_repository。原因如下：

Git 代码库规则依赖于系统 git(1)，而 HTTP 下载器内置于 Bazel 中，没有系统依赖项。
http_archive 支持将 urls 列表用作镜像，而 git_repository 仅支持单个 remote。
http_archive 适用于代码库缓存，但不适用于 git_repository。如需了解详情，请参阅 #5116。

属性

`name`	名称；必需此代码库的唯一名称。
`branch`	字符串；可选要签出的远程代码库中的分支。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`build_file`	标签；可选要用作此代码库的 BUILD 文件的文件。此属性是绝对标签（对于主代码库，请使用“@//”）。该文件不必命名为 BUILD，但可以这样命名（例如，BUILD.new-repo-name 可能很适合用来将其与代码库的实际 BUILD 文件区分开来）。
`build_file_content`	字符串；可选此代码库的 BUILD 文件的内容。
`commit`	字符串；可选要检出的特定提交。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`init_submodules`	布尔值；可选是否克隆代码库中的子模块。
`patch_args`	字符串列表；可选给补丁工具的参数。默认为 -p0（请参阅“patch_strip”属性），不过通常需要为 git 生成的补丁使用 -p1。如果指定了多个 -p 参数，则最后一个参数将生效。如果指定了 -p 以外的参数，Bazel 将回退使用 patch 命令行工具，而不是使用原生 Bazel 补丁实现。当回退到补丁命令行工具且未指定 patch_tool 属性时，系统将使用 `patch`。
`patch_cmds`	字符串列表；可选在应用补丁后，要在 Linux/Macos 上应用的 Bash 命令序列。
`patch_cmds_win`	字符串列表；可选在应用补丁后，要在 Windows 上应用的一系列 PowerShell 命令。如果未设置此属性，系统将在 Windows 上执行 patch_cmds，这需要 Bash 二进制文件存在。
`patch_strip`	整数；可选将其设置为 `N` 时，这相当于将 `-pN` 插入到 `patch_args` 的开头。
`patch_tool`	字符串；可选要使用的 patch(1) 实用程序。如果指定了此参数，Bazel 将使用指定的补丁工具，而不是 Bazel 原生补丁实现。
`patches`	标签列表；可选解压缩归档文件后要作为补丁应用的文件列表。默认情况下，它使用不支持模糊匹配和二进制补丁的 Bazel 原生补丁实现，但如果指定了 `patch_tool` 属性或 `patch_args` 属性中存在 `-p` 以外的参数，则 Bazel 会回退为使用补丁命令行工具。
`recursive_init_submodules`	布尔值；可选是否在代码库中递归克隆子模块。
`remote`	字符串；必需远程 Git 代码库的 URI
`remote_module_file_integrity`	字符串；可选仅供内部使用。
`remote_module_file_urls`	字符串列表；可选仅供内部使用。
`repo_mapping`	字典：String -> String；可选仅在 `WORKSPACE` 上下文中：一个字典，用于将本地代码库名称转换为全局代码库名称。这样，您就可以控制此代码库的依赖项的工作区依赖项解析。例如，条目 `"@foo": "@bar"` 声明，每当此仓库依赖于 `@foo`（例如依赖于 `@foo//some:target`）时，它实际上应在全局声明的 `@bar` (`@bar//some:target`) 中解析该依赖项。 `MODULE.bazel` 上下文（在模块扩展的实现函数内调用仓库规则时）_不支持_此属性。
`shallow_since`	字符串；可选可选日期，不得晚于指定提交；如果指定了标记或分支（始终可以使用 --depth=1 进行克隆），则不允许使用此参数。设置接近指定提交日期的日期后，即使服务器不支持对任意提交进行浅提取，也可能允许浅克隆代码库。由于 git 的 --shallow-since 实现中存在 bug，因此不建议使用此属性，因为这可能会导致提取失败。
`sparse_checkout_file`	标签；可选用于对此代码库中的文件进行稀疏检出的 .gitignore 风格模式文件。您可以指定 `sparse_checkout_patterns` 或 `sparse_checkout_file`，也可以不指定这两者，但不能同时指定这两者。
`sparse_checkout_patterns`	字符串列表；可选用于对此代码库中的文件进行稀疏检出的模式序列。
`strip_prefix`	字符串；可选要从提取的文件中剥离的目录前缀。
`tag`	字符串；可选标记要签出的远程代码库中的版本。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`verbose`	布尔值；可选
`workspace_file`	标签；可选无操作属性；请勿使用。
`workspace_file_content`	字符串；可选无操作属性；请勿使用。

new_git_repository

load("@bazel//tools/build_defs/repo:git.bzl", "new_git_repository")

new_git_repository(name, branch, build_file, build_file_content, commit, init_submodules,
                   patch_args, patch_cmds, patch_cmds_win, patch_strip, patch_tool, patches,
                   recursive_init_submodules, remote, remote_module_file_integrity,
                   remote_module_file_urls, repo_mapping, shallow_since, sparse_checkout_file,
                   sparse_checkout_patterns, strip_prefix, tag, verbose, workspace_file,
                   workspace_file_content)

克隆外部 Git 代码库。

Bazel 会先尝试仅浅提取指定提交。如果该操作失败（通常是因为缺少服务器支持），则会回退到对代码库进行完整提取。

首选 http_archive，而不是 git_repository。原因如下：

Git 代码库规则依赖于系统 git(1)，而 HTTP 下载器内置于 Bazel 中，没有系统依赖项。
http_archive 支持将 urls 列表用作镜像，而 git_repository 仅支持单个 remote。
http_archive 适用于代码库缓存，但不适用于 git_repository。如需了解详情，请参阅 #5116。

属性

`name`	名称；必需此代码库的唯一名称。
`branch`	字符串；可选要签出的远程代码库中的分支。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`build_file`	标签；可选要用作此代码库的 BUILD 文件的文件。此属性是绝对标签（对于主代码库，请使用“@//”）。该文件不必命名为 BUILD，但可以这样命名（例如，BUILD.new-repo-name 可能很适合用于将其与代码库的实际 BUILD 文件区分开来）。
`build_file_content`	字符串；可选此代码库的 BUILD 文件的内容。
`commit`	字符串；可选要检出的特定提交。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`init_submodules`	布尔值；可选是否克隆代码库中的子模块。
`patch_args`	字符串列表；可选给补丁工具的参数。默认为 -p0（请参阅“patch_strip”属性），不过通常需要为 git 生成的补丁使用 -p1。如果指定了多个 -p 参数，则最后一个参数将生效。如果指定了 -p 以外的参数，Bazel 将回退使用 patch 命令行工具，而不是使用原生 Bazel 补丁实现。当回退到补丁命令行工具且未指定 patch_tool 属性时，系统将使用 `patch`。
`patch_cmds`	字符串列表；可选在应用补丁后，要在 Linux/Macos 上应用的 Bash 命令序列。
`patch_cmds_win`	字符串列表；可选在应用补丁后，要在 Windows 上应用的一系列 PowerShell 命令。如果未设置此属性，系统将在 Windows 上执行 patch_cmds，这需要 Bash 二进制文件存在。
`patch_strip`	整数；可选将其设置为 `N` 时，这相当于将 `-pN` 插入到 `patch_args` 的开头。
`patch_tool`	字符串；可选要使用的 patch(1) 实用程序。如果指定了此参数，Bazel 将使用指定的补丁工具，而不是 Bazel 原生补丁实现。
`patches`	标签列表；可选解压缩归档文件后要作为补丁应用的文件列表。默认情况下，它使用不支持模糊匹配和二进制补丁的 Bazel 原生补丁实现，但如果指定了 `patch_tool` 属性或 `patch_args` 属性中存在 `-p` 以外的参数，则 Bazel 会回退为使用补丁命令行工具。
`recursive_init_submodules`	布尔值；可选是否在代码库中递归克隆子模块。
`remote`	字符串；必需远程 Git 代码库的 URI
`remote_module_file_integrity`	字符串；可选仅供内部使用。
`remote_module_file_urls`	字符串列表；可选仅供内部使用。
`repo_mapping`	字典：String -> String；可选仅在 `WORKSPACE` 上下文中：一个字典，用于将本地代码库名称转换为全局代码库名称。这样，您就可以控制此代码库的依赖项的工作区依赖项解析。例如，条目 `"@foo": "@bar"` 声明，每当此仓库依赖于 `@foo`（例如依赖于 `@foo//some:target`）时，它实际上应在全局声明的 `@bar` (`@bar//some:target`) 中解析该依赖项。 `MODULE.bazel` 上下文（在模块扩展的实现函数内调用仓库规则时）_不支持_此属性。
`shallow_since`	字符串；可选可选日期，不得晚于指定提交；如果指定了标记或分支（始终可以使用 --depth=1 进行克隆），则不允许使用此参数。设置接近指定提交日期的日期后，即使服务器不支持对任意提交进行浅提取，也可能允许浅克隆代码库。由于 git 的 --shallow-since 实现中存在 bug，因此不建议使用此属性，因为这可能会导致提取失败。
`sparse_checkout_file`	标签；可选用于对此代码库中的文件进行稀疏检出的 .gitignore 风格模式文件。您可以指定 `sparse_checkout_patterns` 或 `sparse_checkout_file`，也可以不指定这两者，但不能同时指定这两者。
`sparse_checkout_patterns`	字符串列表；可选用于对此代码库中的文件进行稀疏检出的模式序列。
`strip_prefix`	字符串；可选要从提取的文件中剥离的目录前缀。
`tag`	字符串；可选标记要签出的远程代码库中的版本。必须指定分支、标记或提交中的一个（且只能指定其中一个）。
`verbose`	布尔值；可选
`workspace_file`	标签；可选无操作属性；请勿使用。
`workspace_file_content`	字符串；可选无操作属性；请勿使用。