Skip to content

Commit 0664a5d

Browse files
committed
address PR feedback re wording
1 parent 99713bb commit 0664a5d

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/env-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
| `--docker-config-base64` | `ENVBUILDER_DOCKER_CONFIG_BASE64` | | The base64 encoded Docker config file that will be used to pull images from private container registries. When this is set, Docker configuration set via the DOCKER_CONFIG environment variable is ignored. |
1919
| `--fallback-image` | `ENVBUILDER_FALLBACK_IMAGE` | | Specifies an alternative image to use when neither an image is declared in the devcontainer.json file nor a Dockerfile is present. If there's a build failure (from a faulty Dockerfile) or a misconfiguration, this image will be the substitute. Set ExitOnBuildFailure to true to halt the container if the build faces an issue. |
2020
| `--exit-on-build-failure` | `ENVBUILDER_EXIT_ON_BUILD_FAILURE` | | Terminates the container upon a build failure. This is handy when preferring the FALLBACK_IMAGE in cases where no devcontainer.json or image is provided. However, it ensures that the container stops if the build process encounters an error. |
21-
| `--exit-on-push-failure` | `ENVBUILDER_EXIT_ON_PUSH_FAILURE` | | ExitOnPushFailure terminates the container upon a push failure. This is useful if failure to push the built image should not block usage of the workspace. |
21+
| `--exit-on-push-failure` | `ENVBUILDER_EXIT_ON_PUSH_FAILURE` | | ExitOnPushFailure terminates the container upon a push failure. This is useful if failure to push the built image should abort execution and result in an error. |
2222
| `--force-safe` | `ENVBUILDER_FORCE_SAFE` | | Ignores any filesystem safety checks. This could cause serious harm to your system! This is used in cases where bypass is needed to unblock customers. |
2323
| `--insecure` | `ENVBUILDER_INSECURE` | | Bypass TLS verification when cloning and pulling from container registries. |
2424
| `--ignore-paths` | `ENVBUILDER_IGNORE_PATHS` | | The comma separated list of paths to ignore when building the workspace. |

options/options.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ type Options struct {
7979
// container stops if the build process encounters an error.
8080
ExitOnBuildFailure bool
8181
// ExitOnPushFailure terminates the container upon a push failure. This is
82-
// useful if failure to push the built image should not block usage
83-
// of the workspace.
82+
// useful if failure to push the built image should abort execution
83+
// and result in an error.
8484
ExitOnPushFailure bool
8585
// ForceSafe ignores any filesystem safety checks. This could cause serious
8686
// harm to your system! This is used in cases where bypass is needed to
@@ -313,8 +313,8 @@ func (o *Options) CLI() serpent.OptionSet {
313313
Env: WithEnvPrefix("EXIT_ON_PUSH_FAILURE"),
314314
Value: serpent.BoolOf(&o.ExitOnPushFailure),
315315
Description: "ExitOnPushFailure terminates the container upon a push failure. " +
316-
"This is useful if failure to push the built image should not block " +
317-
"usage of the workspace.",
316+
"This is useful if failure to push the built image should abort execution " +
317+
"and result in an error.",
318318
},
319319
{
320320
Flag: "force-safe",

options/testdata/options.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ OPTIONS:
6868

6969
--exit-on-push-failure bool, $ENVBUILDER_EXIT_ON_PUSH_FAILURE
7070
ExitOnPushFailure terminates the container upon a push failure. This
71-
is useful if failure to push the built image should not block usage of
72-
the workspace.
71+
is useful if failure to push the built image should abort execution
72+
and result in an error.
7373

7474
--export-env-file string, $ENVBUILDER_EXPORT_ENV_FILE
7575
Optional file path to a .env file where envbuilder will dump

0 commit comments

Comments
 (0)