Class: Ansible::Ruby::Modules::Hg

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

Overview

Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address.

Instance Method Summary collapse

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

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



36
 
# File 'lib/ansible/ruby/modules/generated/source_control/hg.rb', line 36

attribute :clone

#dest ⇒ String

Returns Absolute path of where the repository should be cloned to. This parameter is required, unless clone and update are set to no.

Returns:

  • (String) —

    Absolute path of where the repository should be cloned to. This parameter is required, unless clone and update are set to no



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

attribute :dest

#executable ⇒ Object?

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

Returns:

  • (Object, nil) —

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



40
 
# File 'lib/ansible/ruby/modules/generated/source_control/hg.rb', line 40

attribute :executable

#force ⇒ :yes, ...

Returns Discards uncommitted changes. Runs C(hg update -C). Prior to 1.9, the default was ‘yes`.

Returns:

  • (:yes, :no, nil) —

    Discards uncommitted changes. Runs C(hg update -C). Prior to 1.9, the default was ‘yes`.



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

attribute :force

#purge ⇒ :yes, ...

Returns Deletes untracked files. Runs C(hg purge).

Returns:

  • (:yes, :no, nil) —

    Deletes untracked files. Runs C(hg purge).



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

attribute :purge

#repo ⇒ String

Returns The repository address.

Returns:

  • (String) —

    The repository address.



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

attribute :repo

#revision ⇒ String?

Returns Equivalent C(-r) option in hg command which could be the changeset, revision number, branch name or even tag.

Returns:

  • (String, nil) —

    Equivalent C(-r) option in hg command which could be the changeset, revision number, branch name or even tag.



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

attribute :revision

#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



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

attribute :update