Documentation

PLEASE NOTE: This document applies to v2.18 version and not to the latest stable release v2.19

Documentation for other releases can be found by using the version selector in the top right of any doc page.

git

Manage git checkouts of repositories.

Attributes

check_mode:
  support: full
diff_mode:
  support: none

Parameters

Parameter	Required	Type	Description
accept_hostkey		boolean	Automatically accept the host key when connecting via SSH.
depth		integer	Create a shallow clone with a history truncated to the specified number of commits.
dest	true	string	The destination path where the repository should be cloned.
force		boolean	Force a reset to the specified version, discarding any local changes.
key_file		string	Path to the SSH private key file to use for authentication.
repo	true	string	The repository URL to clone.
single_branch		boolean	Clone only the specified branch.
update		boolean	Update an existing repository to the latest revision.
version		string	The version to checkout. Can be a branch, tag, or commit hash.

{$include_doc /// ## Examples /// /// yaml /// - name: Clone application /// git: /// repo: https://github.com/user/app.git /// dest: /opt/app /// version: v1.2.0 /// /// - name: Clone with SSH /// git: /// repo: git@github.com:user/private-config.git /// dest: /etc/app/config /// key_file: /root/.ssh/deploy_key /// accept_hostkey: yes /// /// - name: Shallow clone /// git: /// repo: https://github.com/user/large-repo.git /// dest: /opt/repo /// depth: 1 /// single_branch: yes /// version: main /// /// - name: Update existing clone /// git: /// repo: https://github.com/user/app.git /// dest: /opt/app /// update: yes ///}