Skip to content

Commit 5dcb593

Browse files
committed
improved docs on build.env
Signed-off-by: WYGIN <[email protected]>
1 parent ff52920 commit 5dcb593

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

content/docs/reference/config/builder-config.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,21 @@ A [builder][builder] configuration schema is as follows:
7474
> will not change despite new lifecycle versions being released.
7575
7676
- #### `build.env` _(optional)_
77-
The [[build.env]] is used to override platform environment variables at build-time. use Env `CNB_BUILD_CONFIG_DIR` to override when building image from cli to change default(`/cnb/build-config`) directory of these build-time environment variables stored
77+
The [[[build.env]]](https://github.com/buildpacks/spec/blob/main/buildpack.md#environment-variable-modification-rules) is used to specify [operator-defined](https://github.com/buildpacks/spec/blob/main/platform.md#operator-defined-variables) build-time environment variables for buildpacks. Set `CNB_BUILD_CONFIG_DIR` in pack's environment to override the default directory (`/cnb/build-config/env`) where environment variable files are stored within the builder.
7878

7979
- **`name`** _(string, required)_\
80-
The Name/Key of the Environment Variable. If Platform Environment Variable key/name is specified, then it is overridden at build-time else it will create a build-time environment variable with the given `name` that is not defined(key/name doesn't exists) at runtime of the container
80+
The name/key of the environment variable. If a platform environment variable with the given key/name exists, it will be overridden at build time. Otherwise, a new build-time environment variable with the given name will be created.
8181

8282
- **`value`** _(string, required)_\
83-
The value of the given name/key of the Environment Variable overriden to
83+
The value of the specified environment variable, depends on the `suffix`.
84+
85+
- **`suffix`** _(string, optional)_\
86+
The type of action performed on platform environment variables, one of [`default`](https://github.com/buildpacks/spec/blob/main/buildpack.md#default), [`override`](https://github.com/buildpacks/spec/blob/main/buildpack.md#override), [`append`](https://github.com/buildpacks/spec/blob/main/buildpack.md#append), or [`prepend`](https://github.com/buildpacks/spec/blob/main/buildpack.md#prepend). Defaults to `default` if this field is omited.
87+
88+
- **`delim`** _(string, optional)_\
89+
The delimiter used to concatenate two or more values for the given `name`.
90+
91+
> The `delim` is required when `suffix` is one of `append` or `prepend`.
8492
8593
### Supported archives
8694

0 commit comments

Comments
 (0)