@@ -14,11 +14,10 @@ This module allows you to automatically clone a repository by URL and skip if it
1414module "git-clone" {
1515 count = data.coder_workspace.me.start_count
1616 source = "registry.coder.com/coder/git-clone/coder"
17- version = "1.3.0"
17+ version = "1.3.0"
1818 agent_id = coder_agent.example.id
1919 url = "https://github.com/coder/coder"
2020}
21-
2221```
2322
2423## Examples
@@ -29,12 +28,11 @@ module "git-clone" {
2928module "git-clone" {
3029 count = data.coder_workspace.me.start_count
3130 source = "registry.coder.com/coder/git-clone/coder"
32- version = "1.3.0"
31+ version = "1.3.0"
3332 agent_id = coder_agent.example.id
3433 url = "https://github.com/coder/coder"
3534 base_dir = "~/projects/coder"
3635}
37-
3836```
3937
4038### Git Authentication
@@ -45,7 +43,7 @@ To use with [Git Authentication](https://coder.com/docs/v2/latest/admin/git-prov
4543module "git-clone" {
4644 count = data.coder_workspace.me.start_count
4745 source = "registry.coder.com/coder/git-clone/coder"
48- version = "1.3.0"
46+ version = "1.3.0"
4947 agent_id = coder_agent.example.id
5048 url = "https://github.com/coder/coder"
5149}
@@ -72,7 +70,7 @@ data "coder_parameter" "git_repo" {
7270module "git_clone" {
7371 count = data.coder_workspace.me.start_count
7472 source = "registry.coder.com/coder/git-clone/coder"
75- version = "1.3.0"
73+ version = "1.3.0"
7674 agent_id = coder_agent.example.id
7775 url = data.coder_parameter.git_repo.value
7876}
@@ -107,7 +105,7 @@ Configuring `git-clone` for a self-hosted GitHub Enterprise Server running at `g
107105module "git-clone" {
108106 count = data.coder_workspace.me.start_count
109107 source = "registry.coder.com/coder/git-clone/coder"
110- version = "1.3.0"
108+ version = "1.3.0"
111109 agent_id = coder_agent.example.id
112110 url = "https://github.example.com/coder/coder/tree/feat/example"
113111 git_providers = {
@@ -127,11 +125,10 @@ To GitLab clone with a specific branch like `feat/example`
127125module "git-clone" {
128126 count = data.coder_workspace.me.start_count
129127 source = "registry.coder.com/coder/git-clone/coder"
130- version = "1.3.0"
128+ version = "1.3.0"
131129 agent_id = coder_agent.example.id
132130 url = "https://gitlab.com/coder/coder/-/tree/feat/example"
133131}
134-
135132```
136133
137134Configuring ` git-clone ` for a self-hosted GitLab running at ` gitlab.example.com `
@@ -140,7 +137,7 @@ Configuring `git-clone` for a self-hosted GitLab running at `gitlab.example.com`
140137module "git-clone" {
141138 count = data.coder_workspace.me.start_count
142139 source = "registry.coder.com/coder/git-clone/coder"
143- version = "1.3.0"
140+ version = "1.3.0"
144141 agent_id = coder_agent.example.id
145142 url = "https://gitlab.example.com/coder/coder/-/tree/feat/example"
146143 git_providers = {
@@ -162,12 +159,11 @@ For example, to clone the `feat/example` branch:
162159module "git-clone" {
163160 count = data.coder_workspace.me.start_count
164161 source = "registry.coder.com/coder/git-clone/coder"
165- version = "1.3.0"
162+ version = "1.3.0"
166163 agent_id = coder_agent.example.id
167164 url = "https://github.com/coder/coder"
168165 branch_name = "feat/example"
169166}
170-
171167```
172168
173169## Git clone with different destination folder
@@ -181,13 +177,12 @@ For example, this will clone into the `~/projects/coder/coder-dev` folder:
181177module "git-clone" {
182178 count = data.coder_workspace.me.start_count
183179 source = "registry.coder.com/coder/git-clone/coder"
184- version = "1.3.0"
180+ version = "1.3.0"
185181 agent_id = coder_agent.example.id
186182 url = "https://github.com/coder/coder"
187183 folder_name = "coder-dev"
188184 base_dir = "~/projects/coder"
189185}
190-
191186```
192187
193188## Git shallow clone
@@ -217,12 +212,11 @@ This is useful for scenarios like using a local mirror with `--reference` to spe
217212module "git-clone" {
218213 count = data.coder_workspace.me.start_count
219214 source = "registry.coder.com/coder/git-clone/coder"
220- version = "1.3.0"
215+ version = "1.3.0"
221216 agent_id = coder_agent.example.id
222217 url = "https://github.com/coder/coder"
223218 clone_args = "--reference /mnt/git-mirrors/coder.git"
224219}
225-
226220```
227221
228222You can also combine multiple arguments:
@@ -231,12 +225,11 @@ You can also combine multiple arguments:
231225module "git-clone" {
232226 count = data.coder_workspace.me.start_count
233227 source = "registry.coder.com/coder/git-clone/coder"
234- version = "1.3.0"
228+ version = "1.3.0"
235229 agent_id = coder_agent.example.id
236230 url = "https://github.com/coder/coder"
237231 clone_args = "--reference /mnt/git-mirrors/coder.git --dissociate"
238232}
239-
240233```
241234
242235## Post-clone script
@@ -248,7 +241,7 @@ This is useful for running initialization tasks like installing dependencies or
248241module "git-clone" {
249242 count = data.coder_workspace.me.start_count
250243 source = "registry.coder.com/coder/git-clone/coder"
251- version = "1.3.0"
244+ version = "1.3.0"
252245 agent_id = coder_agent.example.id
253246 url = "https://github.com/coder/coder"
254247 post_clone_script = <<-EOT
@@ -260,5 +253,4 @@ module "git-clone" {
260253 make setup
261254 EOT
262255}
263-
264256```
0 commit comments