git.py (ansible-2.14.0) | : | git.py (ansible-2.14.1rc1) | ||
---|---|---|---|---|
skipping to change at line 32 | skipping to change at line 32 | |||
description: | description: | |||
- git, SSH, or HTTP(S) protocol address of the git repository. | - git, SSH, or HTTP(S) protocol address of the git repository. | |||
type: str | type: str | |||
required: true | required: true | |||
aliases: [ name ] | aliases: [ name ] | |||
dest: | dest: | |||
description: | description: | |||
- The path of where the repository should be checked out. This | - The path of where the repository should be checked out. This | |||
is equivalent to C(git clone [repo_url] [directory]). The reposito ry | is equivalent to C(git clone [repo_url] [directory]). The reposito ry | |||
named in I(repo) is not appended to this path and the destination directory must be empty. This | named in I(repo) is not appended to this path and the destination directory must be empty. This | |||
parameter is required, unless I(clone) is set to C(no). | parameter is required, unless I(clone) is set to C(false). | |||
type: path | type: path | |||
required: true | required: true | |||
version: | version: | |||
description: | description: | |||
- What version of the repository to check out. This can be | - What version of the repository to check out. This can be | |||
the literal string C(HEAD), a branch name, a tag name. | the literal string C(HEAD), a branch name, a tag name. | |||
It can also be a I(SHA-1) hash, in which case I(refspec) needs | It can also be a I(SHA-1) hash, in which case I(refspec) needs | |||
to be specified if the given revision is not already available. | to be specified if the given revision is not already available. | |||
type: str | type: str | |||
default: "HEAD" | default: "HEAD" | |||
skipping to change at line 56 | skipping to change at line 56 | |||
- Be aware that this disables a protection against MITM attacks. | - Be aware that this disables a protection against MITM attacks. | |||
- Those using OpenSSH >= 7.5 might want to set I(ssh_opt) to 'Strict HostKeyChecking=accept-new' | - Those using OpenSSH >= 7.5 might want to set I(ssh_opt) to 'Strict HostKeyChecking=accept-new' | |||
instead, it does not remove the MITM issue but it does restrict it to the first attempt. | instead, it does not remove the MITM issue but it does restrict it to the first attempt. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "1.5" | version_added: "1.5" | |||
accept_newhostkey: | accept_newhostkey: | |||
description: | description: | |||
- As of OpenSSH 7.5, "-o StrictHostKeyChecking=accept-new" can be | - As of OpenSSH 7.5, "-o StrictHostKeyChecking=accept-new" can be | |||
used which is safer and will only accepts host keys which are | used which is safer and will only accepts host keys which are | |||
not present or are the same. if C(yes), ensure that | not present or are the same. if C(true), ensure that | |||
"-o StrictHostKeyChecking=accept-new" is present as an ssh option. | "-o StrictHostKeyChecking=accept-new" is present as an ssh option. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "2.12" | version_added: "2.12" | |||
ssh_opts: | ssh_opts: | |||
description: | description: | |||
- Options git will pass to ssh when used as protocol, it works via C (git)'s | - Options git will pass to ssh when used as protocol, it works via C (git)'s | |||
GIT_SSH/GIT_SSH_COMMAND environment variables. | GIT_SSH/GIT_SSH_COMMAND environment variables. | |||
- For older versions it appends GIT_SSH_OPTS (specific to this modul e) to the | - For older versions it appends GIT_SSH_OPTS (specific to this modul e) to the | |||
variables above or via a wrapper script. | variables above or via a wrapper script. | |||
skipping to change at line 101 | skipping to change at line 101 | |||
- Add an additional refspec to be fetched. | - Add an additional refspec to be fetched. | |||
If version is set to a I(SHA-1) not reachable from any branch | If version is set to a I(SHA-1) not reachable from any branch | |||
or tag, this option may be necessary to specify the ref containing | or tag, this option may be necessary to specify the ref containing | |||
the I(SHA-1). | the I(SHA-1). | |||
Uses the same syntax as the C(git fetch) command. | Uses the same syntax as the C(git fetch) command. | |||
An example value could be "refs/meta/config". | An example value could be "refs/meta/config". | |||
type: str | type: str | |||
version_added: "1.9" | version_added: "1.9" | |||
force: | force: | |||
description: | description: | |||
- If C(yes), any modified files in the working | - If C(true), any modified files in the working | |||
repository will be discarded. Prior to 0.7, this was always | repository will be discarded. Prior to 0.7, this was always | |||
C(yes) and could not be disabled. Prior to 1.9, the default was | C(true) and could not be disabled. Prior to 1.9, the default was | |||
C(yes). | C(true). | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "0.7" | version_added: "0.7" | |||
depth: | depth: | |||
description: | description: | |||
- Create a shallow clone with a history truncated to the specified | - Create a shallow clone with a history truncated to the specified | |||
number or revisions. The minimum possible value is C(1), otherwise | number or revisions. The minimum possible value is C(1), otherwise | |||
ignored. Needs I(git>=1.9.1) to work correctly. | ignored. Needs I(git>=1.9.1) to work correctly. | |||
type: int | type: int | |||
version_added: "1.2" | version_added: "1.2" | |||
clone: | clone: | |||
description: | description: | |||
- If C(no), do not clone the repository even if it does not exist lo cally. | - If C(false), do not clone the repository even if it does not exist locally. | |||
type: bool | type: bool | |||
default: 'yes' | default: 'yes' | |||
version_added: "1.9" | version_added: "1.9" | |||
update: | update: | |||
description: | description: | |||
- If C(no), do not retrieve new revisions from the origin repository . | - If C(false), do not retrieve new revisions from the origin reposit ory. | |||
- Operations like archive will work on the existing (old) repository and might | - Operations like archive will work on the existing (old) repository and might | |||
not respond to changes to the options version or remote. | not respond to changes to the options version or remote. | |||
type: bool | type: bool | |||
default: 'yes' | default: 'yes' | |||
version_added: "1.2" | version_added: "1.2" | |||
executable: | executable: | |||
description: | description: | |||
- Path to git executable to use. If not supplied, | - Path to git executable to use. If not supplied, | |||
the normal mechanism for resolving binary paths will be used. | the normal mechanism for resolving binary paths will be used. | |||
type: path | type: path | |||
version_added: "1.4" | version_added: "1.4" | |||
bare: | bare: | |||
description: | description: | |||
- If C(yes), repository will be created as a bare repo, otherwise | - If C(true), repository will be created as a bare repo, otherwise | |||
it will be a standard repo with a workspace. | it will be a standard repo with a workspace. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "1.4" | version_added: "1.4" | |||
umask: | umask: | |||
description: | description: | |||
- The umask to set before doing any checkouts, or any other | - The umask to set before doing any checkouts, or any other | |||
repository maintenance. | repository maintenance. | |||
type: raw | type: raw | |||
version_added: "2.2" | version_added: "2.2" | |||
recursive: | recursive: | |||
description: | description: | |||
- If C(no), repository will be cloned without the --recursive | - If C(false), repository will be cloned without the --recursive | |||
option, skipping sub-modules. | option, skipping sub-modules. | |||
type: bool | type: bool | |||
default: 'yes' | default: 'yes' | |||
version_added: "1.6" | version_added: "1.6" | |||
single_branch: | single_branch: | |||
description: | description: | |||
- Clone only the history leading to the tip of the specified revisio n. | - Clone only the history leading to the tip of the specified revisio n. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: '2.11' | version_added: '2.11' | |||
track_submodules: | track_submodules: | |||
description: | description: | |||
- If C(yes), submodules will track the latest commit on their | - If C(true), submodules will track the latest commit on their | |||
master branch (or other branch specified in .gitmodules). If | master branch (or other branch specified in .gitmodules). If | |||
C(no), submodules will be kept at the revision specified by the | C(false), submodules will be kept at the revision specified by the | |||
main project. This is equivalent to specifying the --remote flag | main project. This is equivalent to specifying the --remote flag | |||
to git submodule update. | to git submodule update. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "1.8" | version_added: "1.8" | |||
verify_commit: | verify_commit: | |||
description: | description: | |||
- If C(yes), when cloning or checking out a I(version) verify the | - If C(true), when cloning or checking out a I(version) verify the | |||
signature of a GPG signed commit. This requires git version>=2.1.0 | 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 | to be installed. The commit MUST be signed and the public key MUST | |||
be present in the GPG keyring. | be present in the GPG keyring. | |||
type: bool | type: bool | |||
default: 'no' | default: 'no' | |||
version_added: "2.0" | version_added: "2.0" | |||
archive: | archive: | |||
description: | description: | |||
- Specify archive file path with extension. If specified, creates an | - Specify archive file path with extension. If specified, creates an | |||
End of changes. 11 change blocks. | ||||
12 lines changed or deleted | 12 lines changed or added |