| parameter |
required |
default |
choices |
comments |
accept_hostkey
(added in 1.5) |
no |
no |
|
if yes, ensure that "-o StrictHostKeyChecking=no" is present as an ssh options.
|
archive
(added in 2.4) |
no |
|
|
Specify archive file path with extension. If specified, creates an archive file of the specified format containing the tree structure for the source tree. Allowed archive formats ["zip", "tar.gz", "tar", "tgz"]
|
bare
(added in 1.4) |
no |
no |
|
if yes, repository will be created as a bare repo, otherwise it will be a standard repo with a workspace.
|
clone
(added in 1.9) |
no |
yes |
|
If no, do not clone the repository if it does not exist locally
|
depth
|
no |
|
|
Create a shallow clone with a history truncated to the specified number or revisions. The minimum possible value is 1, otherwise ignored. Needs git>=1.9.1 to work correctly.
|
dest
|
yes |
|
|
The path of where the repository should be checked out. This parameter is required, unless clone is set to no.
|
executable
(added in 1.4) |
no |
|
|
Path to git executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.
|
force
|
no |
no |
|
If yes, any modified files in the working repository will be discarded. Prior to 0.7, this was always 'yes' and could not be disabled. Prior to 1.9, the default was `yes`
|
key_file
(added in 1.5) |
no |
None |
|
Specify an optional private key file to use for the checkout.
|
recursive
(added in 1.6) |
no |
yes |
|
if no, repository will be cloned without the --recursive option, skipping sub-modules.
|
reference
(added in 1.4) |
no |
|
|
Reference repository (see "git clone --reference ...")
|
refspec
(added in 1.9) |
no |
|
|
Add an additional refspec to be fetched. If version is set to a SHA-1 not reachable from any branch or tag, this option may be necessary to specify the ref containing the SHA-1. Uses the same syntax as the 'git fetch' command. An example value could be "refs/meta/config".
|
remote
|
no |
origin |
|
Name of the remote.
|
repo
|
yes |
|
|
git, SSH, or HTTP(S) protocol address of the git repository.
aliases: name
|
ssh_opts
(added in 1.5) |
no |
None |
|
Creates a wrapper script and exports the path as GIT_SSH which git then automatically uses to override ssh arguments. An example value could be "-o StrictHostKeyChecking=no"
|
track_submodules
(added in 1.8) |
no |
no |
|
if yes, submodules will track the latest commit on their master branch (or other branch specified in .gitmodules). If no, submodules will be kept at the revision specified by the main project. This is equivalent to specifying the --remote flag to git submodule update.
|
umask
(added in 2.2) |
no |
|
|
The umask to set before doing any checkouts, or any other repository maintenance.
|
update
|
no |
yes |
|
If no, do not retrieve new revisions from the origin repository
|
verify_commit
(added in 2.0) |
no |
no |
|
if yes, when cloning or checking out a version verify the signature of a GPG signed commit. This requires git version>=2.1.0 to be installed. The commit MUST be signed and the public key MUST be present in the GPG keyring.
|
version
|
no |
HEAD |
|
What version of the repository to check out. This can be the the literal string HEAD, a branch name, a tag name. It can also be a SHA-1 hash, in which case refspec needs to be specified if the given revision is not already available.
|