Git 代码库规则

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