以下函数可以从 @bazel_tools//tools/build_defs/repo:git.bzl
加载。
克隆外部 Git 代码库的规则。
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 将回退为使用补丁命令行工具,而不是 Bazel 原生补丁实现。当回退到补丁命令行工具且未指定 patch_tool 属性时,系统将使用“patch”。 |
patch_cmds |
字符串列表(可选)
应用补丁后,在 Linux/Macos 上应用的 Bash 命令序列。 |
patch_cmds_win |
字符串列表(可选)
应用补丁后,在 Windows 上应用的 Powershell 命令序列。如果未设置该属性,则补丁_cmds 将在 Windows 上执行,这需要 Bash 二进制文件存在。 |
patch_tool |
字符串;可选
要使用的补丁(1) 实用程序。如果指定,Bazel 将使用指定的补丁工具,而不是 Bazel 原生补丁实现。 |
patches |
标签列表(可选)
提取归档文件后要作为补丁应用的文件列表。默认情况下,它使用不支持模糊匹配和二进制补丁的 Bazel 原生补丁实现,但如果指定了“patch_tool”属性或者“patch_args”属性中存在除“-p”以外的参数,Bazel 将回退为使用补丁命令行工具。 |
recursive_init_submodules |
布尔值;可选
是否以递归方式克隆代码库中的子模块。 |
remote |
字符串;必填
远程 Git 代码库的 URI |
repo_mapping |
字典:String -> String;必需
从本地代码库名称到全局代码库名称的字典。这样,您就可以控制此代码库依赖项的工作区依赖项解析。 例如,条目"@foo": "@bar"` 就声明,每当此代码库依赖于“@foo”(例如对“@foo//some:target”的依赖项),它实际上应在全局声明的 `@bar`(“@bar//some:target”)中解析该依赖项。 |
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”,也可以同时指定其中之一,但不能同时指定两者。 |
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 将回退为使用补丁命令行工具,而不是 Bazel 原生补丁实现。当回退到补丁命令行工具且未指定 patch_tool 属性时,系统将使用“patch”。 |
patch_cmds |
字符串列表(可选)
应用补丁后,在 Linux/Macos 上应用的 Bash 命令序列。 |
patch_cmds_win |
字符串列表(可选)
应用补丁后,在 Windows 上应用的 Powershell 命令序列。如果未设置该属性,则补丁_cmds 将在 Windows 上执行,这需要 Bash 二进制文件存在。 |
patch_tool |
字符串;可选
要使用的补丁(1) 实用程序。如果指定,Bazel 将使用指定的补丁工具,而不是 Bazel 原生补丁实现。 |
patches |
标签列表(可选)
提取归档文件后要作为补丁应用的文件列表。默认情况下,它使用不支持模糊匹配和二进制补丁的 Bazel 原生补丁实现,但如果指定了“patch_tool”属性或者“patch_args”属性中存在除“-p”以外的参数,Bazel 将回退为使用补丁命令行工具。 |
recursive_init_submodules |
布尔值;可选
是否以递归方式克隆代码库中的子模块。 |
remote |
字符串;必填
远程 Git 代码库的 URI |
repo_mapping |
字典:String -> String;必需
从本地代码库名称到全局代码库名称的字典。这样,您就可以控制此代码库依赖项的工作区依赖项解析。 例如,条目"@foo": "@bar"` 就声明,每当此代码库依赖于“@foo”(例如对“@foo//some:target”的依赖项),它实际上应在全局声明的 `@bar`(“@bar//some:target”)中解析该依赖项。 |
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”,也可以同时指定其中之一,但不能同时指定两者。 |