Class: Ansible::Ruby::Modules::Git

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/source_control/git.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#accept_hostkey ⇒ :yes, ...

Returns if C(yes), adds the hostkey for the repo url if not already added. If ssh_opts contains “-o StrictHostKeyChecking=no”, this parameter is ignored.

Returns:

  • (:yes, :no, nil) —

    if C(yes), adds the hostkey for the repo url if not already added. If ssh_opts contains “-o StrictHostKeyChecking=no”, this parameter is ignored.



22
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 22

attribute :accept_hostkey

#bare ⇒ :yes, ...

Returns if C(yes), repository will be created as a bare repo, otherwise it will be a standard repo with a workspace.

Returns:

  • (:yes, :no, nil) —

    if C(yes), repository will be created as a bare repo, otherwise it will be a standard repo with a workspace.



61
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 61

attribute :bare

#clone ⇒ :yes, ...

Returns If C(no), do not clone the repository if it does not exist locally.

Returns:

  • (:yes, :no, nil) —

    If C(no), do not clone the repository if it does not exist locally



50
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 50

attribute :clone

#depth ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



47
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 47

attribute :depth

#dest ⇒ String

Returns Absolute path of where the repository should be checked out to. This parameter is required, unless C(clone) is set to C(no) This change was made in version 1.8.3. Prior to this version, the C(dest) parameter was always required.

Returns:

  • (String) —

    Absolute path of where the repository should be checked out to. This parameter is required, unless C(clone) is set to C(no) This change was made in version 1.8.3. Prior to this version, the C(dest) parameter was always required.



14
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 14

attribute :dest

#executable ⇒ Object?

Returns Path to git executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.

Returns:

  • (Object, nil) —

    Path to git executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.



58
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 58

attribute :executable

#force ⇒ :yes, ...

Returns 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`.

Returns:

  • (:yes, :no, nil) —

    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`



43
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 43

attribute :force

#key_file ⇒ Object?

Returns Specify an optional private key file to use for the checkout.

Returns:

  • (Object, nil) —

    Specify an optional private key file to use for the checkout.



29
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 29

attribute :key_file

#recursive ⇒ :yes, ...

Returns if C(no), repository will be cloned without the –recursive option, skipping sub-modules.

Returns:

  • (:yes, :no, nil) —

    if C(no), repository will be cloned without the –recursive option, skipping sub-modules.



65
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 65

attribute :recursive

#reference ⇒ Object?

Returns Reference repository (see “git clone –reference …”).

Returns:

  • (Object, nil) —

    Reference repository (see “git clone –reference …”)



32
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 32

attribute :reference

#refspec ⇒ String?

Returns Add an additional refspec to be fetched. 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 the I(SHA-1). Uses the same syntax as the ‘git fetch’ command. An example value could be “refs/meta/config”.

Returns:

  • (String, nil) —

    Add an additional refspec to be fetched. 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 the I(SHA-1). Uses the same syntax as the ‘git fetch’ command. An example value could be “refs/meta/config”.



39
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 39

attribute :refspec

#remote ⇒ String?

Returns Name of the remote.

Returns:

  • (String, nil) —

    Name of the remote.



35
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 35

attribute :remote

#repo ⇒ String

Returns git, SSH, or HTTP(S) protocol address of the git repository.

Returns:

  • (String) —

    git, SSH, or HTTP(S) protocol address of the git repository.



10
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 10

attribute :repo

#ssh_opts ⇒ Object?

Returns 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”.

Returns:

  • (Object, nil) —

    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”



26
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 26

attribute :ssh_opts

#track_submodules ⇒ :yes, ...

Returns 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.

Returns:

  • (:yes, :no, nil) —

    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.



69
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 69

attribute :track_submodules

#update ⇒ :yes, ...

Returns If C(no), do not retrieve new revisions from the origin repository.

Returns:

  • (:yes, :no, nil) —

    If C(no), do not retrieve new revisions from the origin repository



54
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 54

attribute :update

#verify_commit ⇒ :yes, ...

Returns 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 trusted in the GPG trustdb.

Returns:

  • (:yes, :no, nil) —

    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 trusted in the GPG trustdb.



73
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 73

attribute :verify_commit

#version ⇒ String?

Returns What version of the repository to check out. This can be the full 40-character I(SHA-1) hash, the literal string C(HEAD), a branch name, or a tag name.

Returns:

  • (String, nil) —

    What version of the repository to check out. This can be the full 40-character I(SHA-1) hash, the literal string C(HEAD), a branch name, or a tag name.



18
 
# File 'lib/ansible/ruby/modules/generated/core/source_control/git.rb', line 18

attribute :version