git repository rules

Report an issue View source Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

The following functions can be loaded from @bazel_tools//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,
               shallow_since, strip_prefix, tag, verbose, workspace_file, workspace_file_content)

Clone an external git repository.

Clones a Git repository, checks out the specified tag, or commit, and makes its targets available for binding. Also determine the id of the commit actually checked out and its date, and return a dict with parameters that provide a reproducible version of this rule (which a tag not necessarily is).

Attributes

`name`	Name; required A unique name for this repository.
`branch`	String; optional branch in the remote repository to checked out. Precisely one of branch, tag, or commit must be specified.
`build_file`	Label; optional The file to use as the BUILD file for this repository.This attribute is an absolute label (use '@//' for the main repo). The file does not need to be named BUILD, but can be (something like BUILD.new-repo-name may work well for distinguishing it from the repository's actual BUILD files. Either build_file or build_file_content must be specified.
`build_file_content`	String; optional The content for the BUILD file for this repository. Either build_file or build_file_content must be specified.
`commit`	String; optional specific commit to be checked out. Precisely one of branch, tag, or commit must be specified.
`init_submodules`	Boolean; optional Whether to clone submodules in the repository.
`patch_args`	List of strings; optional The arguments given to the patch tool. Defaults to -p0, however -p1 will usually be needed for patches generated by git. If multiple -p arguments are specified, the last one will take effect.If arguments other than -p are specified, Bazel will fall back to use patch command line tool instead of the Bazel-native patch implementation. When falling back to patch command line tool and patch_tool attribute is not specified, `patch` will be used.
`patch_cmds`	List of strings; optional Sequence of Bash commands to be applied on Linux/Macos after patches are applied.
`patch_cmds_win`	List of strings; optional Sequence of Powershell commands to be applied on Windows after patches are applied. If this attribute is not set, patch_cmds will be executed on Windows, which requires Bash binary to exist.
`patch_tool`	String; optional The patch(1) utility to use. If this is specified, Bazel will use the specified patch tool instead of the Bazel-native patch implementation.
`patches`	List of labels; optional A list of files that are to be applied as patches after extracting the archive. By default, it uses the Bazel-native patch implementation which doesn't support fuzz match and binary patch, but Bazel will fall back to use patch command line tool if `patch_tool` attribute is specified or there are arguments other than `-p` in `patch_args` attribute.
`recursive_init_submodules`	Boolean; optional Whether to clone submodules recursively in the repository.
`remote`	String; required The URI of the remote Git repository
`shallow_since`	String; optional an optional date, not after the specified commit; the argument is not allowed if a tag is specified (which allows cloning with depth 1). Setting such a date close to the specified commit allows for a more shallow clone of the repository, saving bandwidth and wall-clock time.
`strip_prefix`	String; optional A directory prefix to strip from the extracted files.
`tag`	String; optional tag in the remote repository to checked out. Precisely one of branch, tag, or commit must be specified.
`verbose`	Boolean; optional
`workspace_file`	Label; optional The file to use as the `WORKSPACE` file for this repository. Either `workspace_file` or `workspace_file_content` can be specified, or neither, but not both.
`workspace_file_content`	String; optional The content for the WORKSPACE file for this repository. Either `workspace_file` or `workspace_file_content` can be specified, or neither, but not both.

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, shallow_since, strip_prefix, tag, verbose,
                   workspace_file, workspace_file_content)

Clone an external git repository.

Attributes

`name`	Name; required A unique name for this repository.
`branch`	String; optional branch in the remote repository to checked out. Precisely one of branch, tag, or commit must be specified.
`build_file`	Label; optional The file to use as the BUILD file for this repository.This attribute is an absolute label (use '@//' for the main repo). The file does not need to be named BUILD, but can be (something like BUILD.new-repo-name may work well for distinguishing it from the repository's actual BUILD files. Either build_file or build_file_content must be specified.
`build_file_content`	String; optional The content for the BUILD file for this repository. Either build_file or build_file_content must be specified.
`commit`	String; optional specific commit to be checked out. Precisely one of branch, tag, or commit must be specified.
`init_submodules`	Boolean; optional Whether to clone submodules in the repository.
`patch_args`	List of strings; optional The arguments given to the patch tool. Defaults to -p0, however -p1 will usually be needed for patches generated by git. If multiple -p arguments are specified, the last one will take effect.If arguments other than -p are specified, Bazel will fall back to use patch command line tool instead of the Bazel-native patch implementation. When falling back to patch command line tool and patch_tool attribute is not specified, `patch` will be used.
`patch_cmds`	List of strings; optional Sequence of Bash commands to be applied on Linux/Macos after patches are applied.
`patch_cmds_win`	List of strings; optional Sequence of Powershell commands to be applied on Windows after patches are applied. If this attribute is not set, patch_cmds will be executed on Windows, which requires Bash binary to exist.
`patch_tool`	String; optional The patch(1) utility to use. If this is specified, Bazel will use the specified patch tool instead of the Bazel-native patch implementation.
`patches`	List of labels; optional A list of files that are to be applied as patches after extracting the archive. By default, it uses the Bazel-native patch implementation which doesn't support fuzz match and binary patch, but Bazel will fall back to use patch command line tool if `patch_tool` attribute is specified or there are arguments other than `-p` in `patch_args` attribute.
`recursive_init_submodules`	Boolean; optional Whether to clone submodules recursively in the repository.
`remote`	String; required The URI of the remote Git repository
`shallow_since`	String; optional an optional date, not after the specified commit; the argument is not allowed if a tag is specified (which allows cloning with depth 1). Setting such a date close to the specified commit allows for a more shallow clone of the repository, saving bandwidth and wall-clock time.
`strip_prefix`	String; optional A directory prefix to strip from the extracted files.
`tag`	String; optional tag in the remote repository to checked out. Precisely one of branch, tag, or commit must be specified.
`verbose`	Boolean; optional
`workspace_file`	Label; optional The file to use as the `WORKSPACE` file for this repository. Either `workspace_file` or `workspace_file_content` can be specified, or neither, but not both.
`workspace_file_content`	String; optional The content for the WORKSPACE file for this repository. Either `workspace_file` or `workspace_file_content` can be specified, or neither, but not both.