Document builder property available in project descriptor (#761)

* Document builder property available in project descriptor Signed-off-by: Mars Hall <[email protected]> * Define io.buildpacks.builder in Config Reference Signed-off-by: Mars Hall <[email protected]> * Correct the example toml Signed-off-by: Mars Hall <[email protected]> --------- Signed-off-by: Mars Hall <[email protected]>
buildpacks · Aug 23, 2024 · 9f88e46 · 9f88e46
1 parent 0463e8b
commit 9f88e46
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/content/docs/for-app-developers/how-to/build-inputs/use-project-toml.md b/content/docs/for-app-developers/how-to/build-inputs/use-project-toml.md
@@ -107,6 +107,21 @@ pack build sample-app \
 docker run sample-app
 ```
 
+### Specify Builder
+The builder can also be [specified](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md#iobuildpacksbuilder-optional) in `project.toml`.
+
+```toml
+[io.buildpacks]
+builder = "cnbs/sample-builder:jammy"
+```
+
+```shell script
+# 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][descriptor-schema], as well as the [specification][spec].
 

diff --git a/content/docs/reference/config/project-descriptor.md b/content/docs/reference/config/project-descriptor.md
@@ -63,6 +63,9 @@ The schema is as follows:
       - **`value`** _(string, optional, default: latest)_\
         The assigned version of the environment variable
 
+   - **`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.