Skip to content
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

Docs for new [[build.env]] table in builder.toml #622

Merged
merged 4 commits into from
Nov 3, 2023
Merged

Docs for new [[build.env]] table in builder.toml #622

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff52920
added docs for new build.env table
WYGIN Oct 25, 2023
5dcb593
improved docs on build.env
WYGIN Oct 26, 2023
16c3a42
improve readability
WYGIN Oct 26, 2023
f7cfa31
Merge branch 'main' into build-config-env
AidanDelaney Nov 3, 2023
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
17 changes: 17 additions & 0 deletions content/docs/reference/config/builder-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,23 @@ A [builder][builder] configuration schema is as follows:
> at the time of `pack`'s release. In other words, for a particular version of `pack`, this default
> will not change despite new lifecycle versions being released.

- #### `build.env` _(optional)_
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.

- **`name`** _(string, required)_\
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.
WYGIN marked this conversation as resolved.
Show resolved Hide resolved

- **`value`** _(string, required)_\
The value of the specified environment variable, depends on the `suffix`.
WYGIN marked this conversation as resolved.
Show resolved Hide resolved

- **`suffix`** _(string, optional)_\
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.
WYGIN marked this conversation as resolved.
Show resolved Hide resolved

- **`delim`** _(string, optional)_\
The delimiter used to concatenate two or more values for the given `name`.

> The `delim` is required when `suffix` is one of `append` or `prepend`.

### Supported archives

Currently, when specifying a URI to a buildpack or lifecycle, only `tar` or `tgz` archive types are supported.
Expand Down
Loading