mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
26 lines
2 KiB
ReStructuredText
26 lines
2 KiB
ReStructuredText
.. _git:
|
|
|
|
git
|
|
```
|
|
|
|
Deploys software (or files) from git checkouts.
|
|
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
| parameter | required | default | comments |
|
|
+====================+==========+=========+============================================================================+
|
|
| repo | yes | | git, ssh, or http protocol address of the git repo |
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
| dest | yes | | absolute path of where the repo should be checked out to |
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
| version | no | HEAD | what version to check out -- either the git SHA, the literal string |
|
|
| | | | 'HEAD', branch name, or a tag name. |
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
| remote | no | origin | name of the remote branch |
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
| force | no | yes | (new in 0.7) If yes, any modified files in the working repository will be |
|
|
| | | | discarded. Prior to 0.7, this was always 'yes' and could not be disabled. |
|
|
+--------------------+----------+---------+----------------------------------------------------------------------------+
|
|
|
|
Example action from Ansible :doc:`playbooks`::
|
|
|
|
git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
|