Skip to content

Commit 9a854fc

Browse files
authored
chore: update docs of ENVBUILDER_GIT_URL to mention devcontainer (#215)
1 parent 7f536ce commit 9a854fc

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ On MacOS or Windows systems, we recommend either using a VM or the provided `.de
329329
| `--insecure` | `ENVBUILDER_INSECURE` | | Bypass TLS verification when cloning and pulling from container registries. |
330330
| `--ignore-paths` | `ENVBUILDER_IGNORE_PATHS` | | The comma separated list of paths to ignore when building the workspace. |
331331
| `--skip-rebuild` | `ENVBUILDER_SKIP_REBUILD` | | Skip building if the MagicFile exists. This is used to skip building when a container is restarting. e.g. docker stop -> docker start This value can always be set to true - even if the container is being started for the first time. |
332-
| `--git-url` | `ENVBUILDER_GIT_URL` | | The URL of the Git repository to clone. This is optional. |
332+
| `--git-url` | `ENVBUILDER_GIT_URL` | | The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional. |
333333
| `--git-clone-depth` | `ENVBUILDER_GIT_CLONE_DEPTH` | | The depth to use when cloning the Git repository. |
334334
| `--git-clone-single-branch` | `ENVBUILDER_GIT_CLONE_SINGLE_BRANCH` | | Clone only a single branch of the Git repository. |
335335
| `--git-username` | `ENVBUILDER_GIT_USERNAME` | | The username to use for Git authentication. This is optional. |

options.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ func (o *Options) CLI() serpent.OptionSet {
303303
Flag: "git-url",
304304
Env: WithEnvPrefix("GIT_URL"),
305305
Value: serpent.StringOf(&o.GitURL),
306-
Description: "The URL of the Git repository to clone. This is optional.",
306+
Description: "The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional.",
307307
},
308308
{
309309
Flag: "git-clone-depth",

testdata/options.golden

+2-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ OPTIONS:
9494
Path to an SSH private key to be used for Git authentication.
9595

9696
--git-url string, $ENVBUILDER_GIT_URL
97-
The URL of the Git repository to clone. This is optional.
97+
The URL of a Git repository containing a Devcontainer or Docker image
98+
to clone. This is optional.
9899

99100
--git-username string, $ENVBUILDER_GIT_USERNAME
100101
The username to use for Git authentication. This is optional.

0 commit comments

Comments
 (0)