Skip to content

Commit 2a84c8b

Browse files
committed
Clarify supported buildpack/lifecycle archive types and URI schemes (#863)
* Clarify supported buildpack/lifecycle archive types and URI schemes Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> * Fix Vale style issues: active voice, wrap buildpacks terms, clean grammar Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> --------- Signed-off-by: xonas1101 <aarushsingh1305@gmail.com> Co-authored-by: Aidan Delaney <adelaney21@bloomberg.net>
1 parent acba7b3 commit 2a84c8b

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

docs/reference/config/builder-config/index.html

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ <h4 id="description-string-optional"><code>description</code> <em>(string, optio
926926
</li>
927927
<li>
928928
<h4 id="buildpacks-list-optional"><code>buildpacks</code> <em>(list, optional)</em></h4>
929-
<p>A list of buildpacks, each with the following fields:</p>
929+
<p>A list of <code>buildpacks</code>, each with the following fields:</p>
930930
<ul>
931931
<li>
932932
<p><strong><code>id</code></strong> <em>(string, optional)</em><br>
@@ -944,26 +944,23 @@ <h4 id="buildpacks-list-optional"><code>buildpacks</code> <em>(list, optional)</
944944
</li>
945945
<li>
946946
<h4 id="order-list-required"><code>order</code> <em>(list, required)</em></h4>
947-
<p>A list of buildpack groups. This list determines the order in which groups of buildpacks
948-
will be tested during detection. Detection is a phase of the <a href="/docs/for-platform-operators/concepts/lifecycle">lifecycle</a> where
949-
buildpacks are tested, one group at a time, for compatibility with the provided application source code. The first
950-
group whose non-optional buildpacks all pass detection will be the group selected for the remainder of the build. Each
951-
group currently contains a single required field:</p>
947+
<p>A list of buildpack groups. This list determines the order in which the lifecycle tests groups of <code>buildpacks</code> during detection. Detection is a phase of the <a href="/docs/for-platform-operators/concepts/lifecycle">lifecycle</a> where the lifecycle tests each <code>buildpacks</code> group, one at a time, for compatibility with the provided app source code. The first
948+
group whose non-optional <code>buildpacks</code> all pass detection will be the group selected for the remainder of the build. Each group currently contains a single required field:</p>
952949
<ul>
953950
<li>
954951
<p><strong><code>group</code></strong> <em>(list, required)</em><br>
955952
A set of buildpack references. Each buildpack reference specified has the following fields:</p>
956953
<ul>
957954
<li>
958955
<p><strong><code>id</code></strong> <em>(string, required)</em><br>
959-
The identifier of a buildpack from the configuration&rsquo;s top-level <code>buildpacks</code> list. Buildpacks with the same ID may
956+
The identifier of a buildpack from the configuration&rsquo;s top-level <code>buildpacks</code> list. <code>Buildpacks</code> with the same ID may
960957
appear in multiple groups at once but never in the same group.</p>
961958
</li>
962959
<li>
963960
<p><strong><code>version</code></strong> <em>(string, optional, default: inferred)</em><br>
964961
The version of the buildpack being referred to. This field may be omitted if
965962
exactly one version of the buildpack
966-
occurs in either the top-level <code>buildpacks</code> list or those buildpacks&rsquo; dependencies.</p>
963+
occurs in either the top-level <code>buildpacks</code> list or in the dependencies of those <code>buildpacks</code>.</p>
967964
</li>
968965
<li>
969966
<p><strong><code>optional</code></strong> <em>(boolean, optional, default: <code>false</code>)</em><br>
@@ -1049,7 +1046,7 @@ <h4 id="lifecycle-optional"><code>lifecycle</code> <em>(optional)</em></h4>
10491046
</li>
10501047
<li>
10511048
<h4 id="buildenv-optional"><code>build.env</code> <em>(optional)</em></h4>
1052-
<p>The <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#environment-variable-modification-rules">[[build.env]]</a> is used to specify <a href="https://github.com/buildpacks/spec/blob/main/platform.md#operator-defined-variables">operator-defined</a> build-time environment variables for buildpacks. Set <code>CNB_BUILD_CONFIG_DIR</code> in pack&rsquo;s environment to override the default directory (<code>/cnb/build-config/env</code>) where environment variable files are stored within the builder.</p>
1049+
<p>The <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#environment-variable-modification-rules">[[build.env]]</a> is used to specify <a href="https://github.com/buildpacks/spec/blob/main/platform.md#operator-defined-variables">operator-defined</a> build-time environment variables for <code>buildpacks</code>. Set <code>CNB_BUILD_CONFIG_DIR</code> in pack&rsquo;s environment to override the default directory (<code>/cnb/build-config/env</code>) where environment variable files are stored within the builder.</p>
10531050
<ul>
10541051
<li>
10551052
<p><strong><code>name</code></strong> <em>(string, required)</em><br>
@@ -1061,7 +1058,7 @@ <h4 id="buildenv-optional"><code>build.env</code> <em>(optional)</em></h4>
10611058
</li>
10621059
<li>
10631060
<p><strong><code>suffix</code></strong> <em>(string, optional)</em><br>
1064-
The type of action used to modify the environment variable when end-users or buildpacks define the same name/key, one of <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#default"><code>default</code></a>, <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#override"><code>override</code></a>, <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#append"><code>append</code></a>, or <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#prepend"><code>prepend</code></a>. Defaults to <code>default</code> if this field is omitted. Operator-defined environment variables take precedence over end-user or buildpack-defined environment variables.</p>
1061+
The type of action used to modify the environment variable when end-users or <code>buildpacks</code> define the same name/key, one of <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#default"><code>default</code></a>, <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#override"><code>override</code></a>, <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#append"><code>append</code></a>, or <a href="https://github.com/buildpacks/spec/blob/main/buildpack.md#prepend"><code>prepend</code></a>. Defaults to <code>default</code> if this field is omitted. Operator-defined environment variables take precedence over end-user or buildpack-defined environment variables.</p>
10651062
</li>
10661063
<li>
10671064
<p><strong><code>delim</code></strong> <em>(string, optional)</em><br>
@@ -1074,7 +1071,17 @@ <h4 id="buildenv-optional"><code>build.env</code> <em>(optional)</em></h4>
10741071
</li>
10751072
</ul>
10761073
<h3 id="supported-archives">Supported archives</h3>
1077-
<p>Currently, when specifying a URI to a buildpack or lifecycle, only <code>tar</code> or <code>tgz</code> archive types are supported.</p>
1074+
<p>A URI to a buildpack or lifecycle can use one of the following sources:</p>
1075+
<ul>
1076+
<li><strong>Archives:</strong> <code>.tar</code> or <code>.tgz</code> files, either local or remote.</li>
1077+
<li><strong>Docker images:</strong> the <code>docker://</code> URI scheme.</li>
1078+
</ul>
1079+
<p><strong>Examples</strong></p>
1080+
<ul>
1081+
<li><code>file:///path/to/buildpack.tgz</code></li>
1082+
<li><code>https://example.com/buildpack.tar</code></li>
1083+
<li><code>docker://example/buildpack:latest</code></li>
1084+
</ul>
10781085

10791086

10801087

0 commit comments

Comments
 (0)