Parameter | Choices/Defaults | Comments |
---|---|---|
clone bool (added in 2.3) |
| If no , do not clone the repository if it does not exist locally. |
dest required | Absolute path of where the repository should be cloned to. This parameter is required, unless clone and update are set to no | |
executable (added in 1.4) | Path to hg executable to use. If not supplied, the normal mechanism for resolving binary paths will be used. | |
force bool |
| Discards uncommitted changes. Runs hg update -C . Prior to 1.9, the default was `yes`. |
purge bool |
| Deletes untracked files. Runs hg purge . |
repo required | The repository address. aliases: name | |
revision | Equivalent -r option in hg command which could be the changeset, revision number, branch name or even tag.aliases: version | |
update bool (added in 2.0) |
| If no , do not retrieve new revisions from the origin repository |
Note
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.- name: 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 - name: Get information about the repository whether or not it has already been cloned locally. hg: repo: git://bitbucket.org/user/repo dest: /srv/checkout clone: no update: no
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/hg_module.html