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 · 66c038d · 66c038d
1 parent 3fb5264
commit 66c038d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 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
@@ -975,6 +975,13 @@ <h3 id="specify-buildpacks-and-envs">Specify Buildpacks and Envs</h3>
 </span></span><span class="line"><span class="cl">
 </span></span><span class="line"><span class="cl"><span class="c1"># run the app</span>
 </span></span><span class="line"><span class="cl">docker run sample-app
+</span></span></code></pre></div><h3 id="specify-builder">Specify Builder</h3>
+<p>The builder can also be <a href="https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md#iobuildpacksbuilder-optional">specified</a> in <code>project.toml</code>.</p>
+<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">io</span><span class="p">.</span><span class="nx">buildpacks</span><span class="p">]</span>
+</span></span><span class="line"><span class="cl"><span class="nx">builder</span> <span class="p">=</span> <span class="s2">&#34;cnbs/sample-builder:jammy&#34;</span>
+</span></span></code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl"><span class="c1"># then the pack command does not require builder to be set</span>
+</span></span><span class="line"><span class="cl">pack build sample-app <span class="se">\
+</span></span></span><span class="line"><span class="cl"><span class="se"></span>    --path  samples/apps/bash-script/
 </span></span></code></pre></div><h3 id="further-reading">Further Reading</h3>
 <p>For more about project descriptors, look at the <a href="/docs/reference/project-descriptor/">schema</a>, as well as the <a href="https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md">specification</a>.</p>
 

diff --git a/docs/reference/config/project-descriptor/index.html b/docs/reference/config/project-descriptor/index.html
@@ -971,6 +971,10 @@ <h4 id="iobuildpacks-_table-optional_"><code>io.buildpacks</code> <em>(table, op
 </ul>
 </li>
 <li>
+<p><strong><code>builder</code></strong> <em>(string, optional)</em><br>
+The builder image to use for the build.</p>
+</li>
+<li>
 <p><strong><code>include</code></strong> <em>(string list, optional)</em><br>
 A list of files to include in the build, while excluding everything else.</p>
 <p>OR</p>

diff --git a/index.html b/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 
 <head>
-	<meta name="generator" content="Hugo 0.132.0">
+	<meta name="generator" content="Hugo 0.133.0">
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     <html lang="en">
     <head>
-    	<meta name="generator" content="Hugo 0.132.0">
+    	<meta name="generator" content="Hugo 0.133.0">
@@ Expand Down @@