From 66c038dd134dd4d13a822694612e654e2727c0c3 Mon Sep 17 00:00:00 2001 From: AidanDelaney Date: Fri, 23 Aug 2024 07:26:19 +0000 Subject: [PATCH] Document builder property available in project descriptor (#761) * Document builder property available in project descriptor Signed-off-by: Mars Hall * Define io.buildpacks.builder in Config Reference Signed-off-by: Mars Hall * Correct the example toml Signed-off-by: Mars Hall --------- Signed-off-by: Mars Hall --- .../how-to/build-inputs/use-project-toml/index.html | 7 +++++++ docs/reference/config/project-descriptor/index.html | 4 ++++ index.html | 2 +- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/for-app-developers/how-to/build-inputs/use-project-toml/index.html b/docs/for-app-developers/how-to/build-inputs/use-project-toml/index.html index ed4aa52e7..156dfce97 100644 --- a/docs/for-app-developers/how-to/build-inputs/use-project-toml/index.html +++ b/docs/for-app-developers/how-to/build-inputs/use-project-toml/index.html @@ -975,6 +975,13 @@

Specify Buildpacks and Envs

# run the app docker run sample-app +

Specify Builder

+

The builder can also be specified in project.toml.

+
[io.buildpacks]
+builder = "cnbs/sample-builder:jammy"
+
# then the pack command does not require builder to be set
+pack build sample-app \
+    --path  samples/apps/bash-script/

Further Reading

For more about project descriptors, look at the schema, as well as the specification.

diff --git a/docs/reference/config/project-descriptor/index.html b/docs/reference/config/project-descriptor/index.html index 03572e174..6047ae4a6 100644 --- a/docs/reference/config/project-descriptor/index.html +++ b/docs/reference/config/project-descriptor/index.html @@ -971,6 +971,10 @@

io.buildpacks (table, op
  • +

    builder (string, optional)
    +The builder image to use for the build.

    +
    • +

  • include (string list, optional)
    A list of files to include in the build, while excluding everything else.

    OR

    diff --git a/index.html b/index.html index 929eb2254..583b36e4e 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - +