mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-13 11:49:11 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -25,60 +25,48 @@ description:
|
|||
- Manage I(git) checkouts of repositories to deploy files or software.
|
||||
options:
|
||||
repo:
|
||||
required: true
|
||||
aliases: [ name ]
|
||||
description:
|
||||
- git, SSH, or HTTP(S) protocol address of the git repository.
|
||||
dest:
|
||||
required: true
|
||||
aliases: [ name ]
|
||||
dest:
|
||||
description:
|
||||
- The path of where the repository should be checked out. This
|
||||
parameter is required, unless C(clone) is set to C(no).
|
||||
required: true
|
||||
version:
|
||||
required: false
|
||||
default: "HEAD"
|
||||
description:
|
||||
- What version of the repository to check out. This can be the
|
||||
the literal string C(HEAD), a branch name, a tag name.
|
||||
It can also be a I(SHA-1) hash, in which case C(refspec) needs
|
||||
to be specified if the given revision is not already available.
|
||||
default: "HEAD"
|
||||
accept_hostkey:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "1.5"
|
||||
description:
|
||||
- if C(yes), ensure that "-o StrictHostKeyChecking=no" is
|
||||
present as an ssh options.
|
||||
ssh_opts:
|
||||
required: false
|
||||
default: None
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.5"
|
||||
ssh_opts:
|
||||
description:
|
||||
- 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"
|
||||
key_file:
|
||||
required: false
|
||||
default: None
|
||||
version_added: "1.5"
|
||||
key_file:
|
||||
description:
|
||||
- Specify an optional private key file to use for the checkout.
|
||||
version_added: "1.5"
|
||||
reference:
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.4"
|
||||
description:
|
||||
- Reference repository (see "git clone --reference ...")
|
||||
version_added: "1.4"
|
||||
remote:
|
||||
required: false
|
||||
default: "origin"
|
||||
description:
|
||||
- Name of the remote.
|
||||
default: "origin"
|
||||
refspec:
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- Add an additional refspec to be fetched.
|
||||
If version is set to a I(SHA-1) not reachable from any branch
|
||||
|
@ -86,103 +74,90 @@ options:
|
|||
the I(SHA-1).
|
||||
Uses the same syntax as the 'git fetch' command.
|
||||
An example value could be "refs/meta/config".
|
||||
version_added: "1.9"
|
||||
force:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "0.7"
|
||||
description:
|
||||
- If C(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`
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "0.7"
|
||||
depth:
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.2"
|
||||
description:
|
||||
- Create a shallow clone with a history truncated to the specified
|
||||
number or revisions. The minimum possible value is C(1), otherwise
|
||||
ignored. Needs I(git>=1.9.1) to work correctly.
|
||||
version_added: "1.2"
|
||||
clone:
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- If C(no), do not clone the repository if it does not exist locally
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "1.9"
|
||||
update:
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "1.2"
|
||||
description:
|
||||
- If C(no), do not retrieve new revisions from the origin repository
|
||||
- Operations like archive will work on the existing (old) repository and might
|
||||
not respond to changes to the options version or remote.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "1.2"
|
||||
executable:
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.4"
|
||||
description:
|
||||
- Path to git executable to use. If not supplied,
|
||||
the normal mechanism for resolving binary paths will be used.
|
||||
bare:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "1.4"
|
||||
bare:
|
||||
description:
|
||||
- if C(yes), repository will be created as a bare repo, otherwise
|
||||
it will be a standard repo with a workspace.
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.4"
|
||||
umask:
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- The umask to set before doing any checkouts, or any other
|
||||
repository maintenance.
|
||||
version_added: "2.2"
|
||||
|
||||
recursive:
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- if C(no), repository will be cloned without the --recursive
|
||||
option, skipping sub-modules.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "1.6"
|
||||
|
||||
track_submodules:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
version_added: "1.8"
|
||||
description:
|
||||
- if C(yes), submodules will track the latest commit on their
|
||||
master branch (or other branch specified in .gitmodules). If
|
||||
C(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.
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.8"
|
||||
|
||||
verify_commit:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- if C(yes), when cloning or checking out a C(version) verify the
|
||||
signature of a GPG signed commit. This requires C(git) version>=2.1.0
|
||||
to be installed. The commit MUST be signed and the public key MUST
|
||||
be present in the GPG keyring.
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.0"
|
||||
|
||||
archive:
|
||||
required: false
|
||||
version_added: "2.4"
|
||||
description:
|
||||
- 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"]
|
||||
version_added: "2.4"
|
||||
|
||||
requirements:
|
||||
- git>=1.7.1 (the command line tool)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue