From 44664793b2fa79bf43aa14a973262aca0cec633e Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 13 Jun 2023 11:02:08 +0200 Subject: [PATCH] build: add description for BUILDKIT_EXPERIMENTAL_SOURCE_POLICY Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- build/building/env-vars.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/build/building/env-vars.md b/build/building/env-vars.md index 35d750866c5d..1400d3833519 100644 --- a/build/building/env-vars.md +++ b/build/building/env-vars.md @@ -9,19 +9,20 @@ redirect_from: You can set the following environment variables to enable, disable, or change the behavior of features related to building: -| Variable | Type | Description | -| ----------------------------------------------------------------- | ----------------- | ---------------------------------------------------- | -| [BUILDKIT_COLORS](#buildkit_colors) | String | Configure text color for the terminal output. | -| [BUILDKIT_HOST](#buildkit_host) | String | Specify host to use for remote builders. | -| [BUILDKIT_PROGRESS](#buildkit_progress) | String | Configure type of progress output. | -| [BUILDX_BUILDER](#buildx_builder) | String | Specify the builder instance to use. | -| [BUILDX_CONFIG](#buildx_config) | String | Specify location for configuration, state, and logs. | -| [BUILDX_EXPERIMENTAL](#buildx_experimental) | Boolean | Turn on experimental features. | -| [BUILDX_GIT_CHECK_DIRTY](#buildx_git_check_dirty) | Boolean | Enable dirty Git checkout detection. | -| [BUILDX_GIT_INFO](#buildx_git_info) | Boolean | Remove Git information in provenance attestations. | -| [BUILDX_GIT_LABELS](#buildx_git_labels) | String \| Boolean | Add Git provenance labels to images. | -| [BUILDX_NO_DEFAULT_ATTESTATIONS](#buildx_no_default_attestations) | Boolean | Turn off default provenance attestations. | -| [BUILDX_NO_DEFAULT_LOAD](#buildx_no_default_load) | Boolean | Turn off loading images to image store by default. | +| Variable | Type | Description | +| --------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------- | +| [BUILDKIT_COLORS](#buildkit_colors) | String | Configure text color for the terminal output. | +| [BUILDKIT_HOST](#buildkit_host) | String | Specify host to use for remote builders. | +| [BUILDKIT_PROGRESS](#buildkit_progress) | String | Configure type of progress output. | +| [BUILDKIT_EXPERIMENTAL_SOURCE_POLICY](#buildkit_experimental_source_policy) | String | Specify a BuildKit source policy file. | +| [BUILDX_BUILDER](#buildx_builder) | String | Specify the builder instance to use. | +| [BUILDX_CONFIG](#buildx_config) | String | Specify location for configuration, state, and logs. | +| [BUILDX_EXPERIMENTAL](#buildx_experimental) | Boolean | Turn on experimental features. | +| [BUILDX_GIT_CHECK_DIRTY](#buildx_git_check_dirty) | Boolean | Enable dirty Git checkout detection. | +| [BUILDX_GIT_INFO](#buildx_git_info) | Boolean | Remove Git information in provenance attestations. | +| [BUILDX_GIT_LABELS](#buildx_git_labels) | String \| Boolean | Add Git provenance labels to images. | +| [BUILDX_NO_DEFAULT_ATTESTATIONS](#buildx_no_default_attestations) | Boolean | Turn off default provenance attestations. | +| [BUILDX_NO_DEFAULT_LOAD](#buildx_no_default_load) | Boolean | Turn off loading images to image store by default. | See also [BuildKit built-in build args](../../engine/reference/builder.md#buildkit-built-in-build-args). @@ -79,6 +80,16 @@ Usage: $ export BUILDKIT_PROGRESS=plain ``` +## BUILDKIT_EXPERIMENTAL_SOURCE_POLICY + +Lets you specify a +[BuildKit source policy](https://github.com/moby/buildkit/blob/master/docs/build-repro.md#reproducing-the-pinned-dependencies) +file for creating reproducible builds with pinned dependencies. + +```console +$ export BUILDKIT_EXPERIMENTAL_SOURCE_POLICY=./policy.json +``` + ## BUILDX_BUILDER Overrides the configured builder instance. Same as the `docker buildx --builder`