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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Git

Defined in:

lib/ansible/ruby/modules/generated/source_control/git.rb

Overview

Manage I(git) checkouts of repositories to deploy files or software.

Instance Method Summary

• #accept_hostkey ⇒ :yes, ...

  If C(yes), ensure that “-o StrictHostKeyChecking=no” is present as an ssh option.

• #archive ⇒ String^?

  Specify archive file path with extension.

• #bare ⇒ :yes, ...

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

• #clone ⇒ :yes, ...

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

• #depth ⇒ Object^?

  Create a shallow clone with a history truncated to the specified number or revisions.

• #dest ⇒ String

  The path of where the repository should be checked out.

• #executable ⇒ Object^?

  Path to git executable to use.

• #force ⇒ :yes, ...

  If C(yes), any modified files in the working repository will be discarded.

• #key_file ⇒ Object^?

  Specify an optional private key file path, on the target host, to use for the checkout.

• #recursive ⇒ :yes, ...

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

• #reference ⇒ Object^?

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

• #refspec ⇒ String^?

  Add an additional refspec to be fetched.

• #remote ⇒ String^?

  Name of the remote.

• #repo ⇒ String

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

• #separate_git_dir ⇒ String^?

  The path to place the cloned repository.

• #ssh_opts ⇒ Object^?

  Creates a wrapper script and exports the path as GIT_SSH which git then automatically uses to override ssh arguments.

• #track_submodules ⇒ :yes, ...

  If C(yes), submodules will track the latest commit on their master branch (or other branch specified in .gitmodules).

• #umask ⇒ Object^?

  The umask to set before doing any checkouts, or any other repository maintenance.

• #update ⇒ :yes, ...

  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.

• #verify_commit ⇒ :yes, ...

  If C(yes), when cloning or checking out a C(version) verify the signature of a GPG signed commit.

• #version ⇒ String^?

  What version of the repository to check out.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#accept_hostkey ⇒ :yes, ...

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

attribute :accept_hostkey

#archive ⇒ String^?

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

attribute :archive

#bare ⇒ :yes, ...

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

attribute :bare

#clone ⇒ :yes, ...

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

attribute :clone

#depth ⇒ Object^?

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

attribute :depth

#dest ⇒ String

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

attribute :dest

#executable ⇒ Object^?

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

attribute :executable

#force ⇒ :yes, ...

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

attribute :force

#key_file ⇒ Object^?

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

attribute :key_file

#recursive ⇒ :yes, ...

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

attribute :recursive

#reference ⇒ Object^?

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

attribute :reference

#refspec ⇒ String^?

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

attribute :refspec

#remote ⇒ String^?

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

attribute :remote

#repo ⇒ String

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

attribute :repo

#separate_git_dir ⇒ String^?

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

attribute :separate_git_dir

#ssh_opts ⇒ Object^?

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

attribute :ssh_opts

#track_submodules ⇒ :yes, ...

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

attribute :track_submodules

#umask ⇒ Object^?

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

attribute :umask

#update ⇒ :yes, ...

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

attribute :update

#verify_commit ⇒ :yes, ...

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

attribute :verify_commit

#version ⇒ String^?

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

attribute :version