Skip to content

chore: update docs of ENVBUILDER_GIT_URL to mention devcontainer #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2024
Merged

chore: update docs of ENVBUILDER_GIT_URL to mention devcontainer #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ On MacOS or Windows systems, we recommend either using a VM or the provided `.de
| `--insecure` | `ENVBUILDER_INSECURE` | | Bypass TLS verification when cloning and pulling from container registries. |
| `--ignore-paths` | `ENVBUILDER_IGNORE_PATHS` | | The comma separated list of paths to ignore when building the workspace. |
| `--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. |
| `--git-url` | `ENVBUILDER_GIT_URL` | | The URL of the Git repository to clone. This is optional. |
| `--git-url` | `ENVBUILDER_GIT_URL` | | The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional. |
| `--git-clone-depth` | `ENVBUILDER_GIT_CLONE_DEPTH` | | The depth to use when cloning the Git repository. |
| `--git-clone-single-branch` | `ENVBUILDER_GIT_CLONE_SINGLE_BRANCH` | | Clone only a single branch of the Git repository. |
| `--git-username` | `ENVBUILDER_GIT_USERNAME` | | The username to use for Git authentication. This is optional. |
Expand Down
2 changes: 1 addition & 1 deletion options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ func (o *Options) CLI() serpent.OptionSet {
Flag: "git-url",
Env: WithEnvPrefix("GIT_URL"),
Value: serpent.StringOf(&o.GitURL),
Description: "The URL of the Git repository to clone. This is optional.",
Description: "The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional.",
},
{
Flag: "git-clone-depth",
Expand Down
3 changes: 2 additions & 1 deletion testdata/options.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ OPTIONS:
Path to an SSH private key to be used for Git authentication.

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

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