ANSIBLE.HG(3)                   ANSIBLE MODULES                  ANSIBLE.HG(3)



NAME
       hg - Manages Mercurial (hg) repositories.

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

OPTIONS
       dest   Absolute path of where the repository should be cloned
              to.(required)

       executable
              Path to hg executable to use. If not supplied, the normal
              mechanism for resolving binary paths will be used.(Added in
              Ansible version 1.4.)


       force  Discards uncommitted changes. Runs hg update -C.  Choices:
              yes,no. (default: yes)

       purge  Deletes untracked files. Runs hg purge. Note this requires purge
              extension to be enabled if purge=yes. This module will modify
              hgrc file on behalf of the user and undo the changes before
              exiting the task.  Choices: yes,no. (default: no)

       repo   The repository address.(required)

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

NOTES
       If the task seems to be hanging, first verify remote host is in
       known_hosts. SSH will prompt user to authorize the first contact with a
       remote host.  To avoid this prompt, one solution is to add the remote
       host public key in /etc/ssh/ssh_known_hosts before calling the hg
       module, with the following command: ssh-keyscan remote_host.com >>
       /etc/ssh/ssh_known_hosts.

EXAMPLES
       # Ensure the current working copy is inside the stable branch and deletes untracked files if any.
       - hg: repo=https://bitbucket.org/user/repo1 dest=/home/user/repo1 revision=stable purge=yes



AUTHOR
       Yeukhon Wong

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#hg



1.4.5                             2014-02-12                     ANSIBLE.HG(3)
