modules/git-clone/README.md

display_name	description	icon	maintainer_github	verified	tags
Git Clone	Clone a Git repository by URL and skip if it exists.	../.icons/git.svg	coder	true	git helper

Git Clone

This module allows you to automatically clone a repository by URL and skip if it exists in the base directory provided.

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.2"
  agent_id = coder_agent.example.id
  url      = "https://github.com/coder/coder"
}

Examples

Custom Path

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.2"
  agent_id = coder_agent.example.id
  url      = "https://github.com/coder/coder"
  base_dir = "~/projects/coder"
}

Git Authentication

To use with Git Authentication, add the provider by ID to your template:

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.2"
  agent_id = coder_agent.example.id
  url      = "https://github.com/coder/coder"
}

data "coder_git_auth" "github" {
  id = "github"
}

Github clone with branch name

To github clone a url at a specific branch like feat/example

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.11"
  agent_id = coder_agent.example.id
  url      = "https://github.com/coder/coder/tree/feat/example"
}

Self host github

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.11"
  agent_id = coder_agent.example.id
  url      = "https://github.example.com/coder/coder/tree/feat/example"
  git_providers = {
    "https://github.example.com/" = {
      tree_path = "/tree/"
    }
  }
}

Gitlab clone with branch name

To gitlab clone a url at a specific branch like feat/example

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.11"
  agent_id = coder_agent.example.id
  url      = "https://gitlab.com/coder/coder/-/tree/feat/example"
}

Self host gitlab

module "git-clone" {
  source   = "registry.coder.com/modules/git-clone/coder"
  version  = "1.0.11"
  agent_id = coder_agent.example.id
  url      = "https://gitlab.example.com/coder/coder/-/tree/feat/example"
  git_providers = {
    "https://gitlab.example.com/" = {
      tree_path = "/-/tree/"
    }
  }
}