git

A git checkout at a branch, tag or commit. Refresh notices when a branch moves on the remote. Removing it leaves the checkout.

step "example" {
  git {
    dest = "..."
    repo = "..."
  }
}

Arguments

Name	Type	Required	Description
dest	string	Yes	Directory to check it out in.
ref	string	No	Branch, tag or full commit. Defaults to the remote’s default branch.
repo	string	Yes	Repository URL. The host needs access to it.

Read-only attributes

Conn3x sets these; reference them as conn3x_git.<circuit>__<step>["<host>"].<name>.

Name	Type	Description
commit	string	The commit checked out.
in_sync	bool	Whether the checkout is at the commit ref points to.

A step lowers to the conn3x_git resource, one instance per host, and connects with its circuit’s ssh block.