Skip to content

Commit 1d8a6bf

Browse files
authored
Merge branch 'main' into platform/migration
2 parents 9cbbcbf + ef9cb98 commit 1d8a6bf

File tree

10 files changed

+66
-11
lines changed

10 files changed

+66
-11
lines changed

content/docs/app-developer-guide/using-inline-buildpacks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ id = "me/rake-tasks"
2727
inline = "rake package"
2828
```
2929

30-
In this example, the `me/rake-tasks` inline buildpack is configured to run after the `example/ruby` buildpack. The inline script is compatible with buildpack API version `0.6` (this is a required field), and it will execute the `rake package` command during the build step.
30+
In this example, the `me/rake-tasks` inline buildpack is configured to run after the `example/ruby` buildpack. The inline script is compatible with Buildpack API version `0.6` (this is a required field), and it will execute the `rake package` command during the build step.
3131

3232
> **Note:** Inline buildpacks will _always_ pass detection.
3333

content/docs/extension-guide/create-extension/building-blocks-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You should see something akin to the following:
2626
```
2727

2828
* The `extension.toml` describes the extension, containing information such as its name, ID, and version, as well as the
29-
buildpack API that it implements. Though extensions are not buildpacks, they are expected to conform to the buildpack
29+
Buildpack API that it implements. Though extensions are not buildpacks, they are expected to conform to the Buildpack
3030
API except where noted. Consult the [spec](https://github.com/buildpacks/spec/blob/main/image_extension.md)
3131
for further details.
3232
* `./bin/detect` is invoked during the `detect` phase. It analyzes application source code to determine if the extension

content/docs/reference/spec/migration/buildpack-api-0.4-0.5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title="Buildpack API 0.4 -> 0.5"
66

77
This guide is most relevant to buildpack authors.
88

9-
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.5) for buildpack API 0.5 for the full list of changes and further details.
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.5) for Buildpack API 0.5 for the full list of changes and further details.
1010

1111
### Stack ID
1212
The buildpack may now indicate compatibility with any stack by specifying the special value `*`.

content/docs/reference/spec/migration/buildpack-api-0.5-0.6.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title="Buildpack API 0.5 -> 0.6"
66

77
This guide is most relevant to buildpack authors.
88

9-
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.6) for buildpack API 0.6 for the full list of changes and further details.
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.6) for Buildpack API 0.6 for the full list of changes and further details.
1010

1111
### Opt-in layer caching and launch.toml format changes
1212

content/docs/reference/spec/migration/buildpack-api-0.6-0.7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title="Buildpack API 0.6 -> 0.7"
66

77
This guide is most relevant to buildpack authors.
88

9-
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.7) for buildpack API 0.7 for the full list of changes and further details.
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.7) for Buildpack API 0.7 for the full list of changes and further details.
1010

1111
### New standardized SBOM format
1212

content/docs/reference/spec/migration/buildpack-api-0.7-0.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title="Buildpack API 0.7 -> 0.8"
66

77
This guide is most relevant to buildpack authors.
88

9-
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.8) for buildpack API 0.8 for the full list of changes and further details.
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.8) for Buildpack API 0.8 for the full list of changes and further details.
1010

1111
### Process-Specific Working Directory
1212

content/docs/reference/spec/migration/buildpack-api-0.8-0.9.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title="Buildpack API 0.8 -> 0.9"
66

77
This guide is most relevant to buildpack authors.
88

9-
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.9) for buildpack API 0.9 for the full list of changes and further details.
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.9) for Buildpack API 0.9 for the full list of changes and further details.
1010

1111
### Shell removal
1212

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
+++
2+
title="Buildpack API 0.9 -> 0.10"
3+
+++
4+
5+
<!--more-->
6+
7+
This guide is most relevant to buildpack authors.
8+
9+
See the [spec release](https://github.com/buildpacks/spec/releases/tag/buildpack%2Fv0.10) for Buildpack API 0.10 for the full list of changes and further details.
10+
11+
### Stacks are deprecated
12+
13+
In Buildpack 0.10, the concepts of stacks and mixins are removed
14+
in favor of existing constructs in the container image ecosystem such as operating system name, operating system distribution, and architecture.
15+
16+
#### Before build
17+
18+
`builder.toml` contains a new table for buildpacks to express the os/arch combinations that they are compatible with:
19+
20+
```toml
21+
[[targets]]
22+
os = "<OS name>"
23+
arch = "<architecture>"
24+
variant = "<architecture variant>"
25+
[[targets.distros]]
26+
name = "<OS distribution name>"
27+
version = "<OS distribution version>"
28+
```
29+
30+
All fields are optional and any missing field is assumed to "match any".
31+
32+
This information will be used by the lifecycle to skip running detect on any buildpack that is not compatible with the current os/arch.
33+
34+
Note that the `[[stacks]]` table is still supported and buildpack authors are encouraged to continue to provide this information for the time being
35+
in order to maintain compatibility with older platforms.
36+
37+
#### During build
38+
39+
The lifecycle will provide the following environment variables during `detect` and `build` to describe the target os/arch:
40+
41+
| Env Variable | Description |
42+
|-----------------------------|-------------------------------------------|
43+
| `CNB_TARGET_OS` | Target OS |
44+
| `CNB_TARGET_ARCH` | Target architecture |
45+
| `CNB_TARGET_ARCH_VARIANT` | Target architecture variant (optional) |
46+
| `CNB_TARGET_DISTRO_NAME` | Target OS distribution name (optional) |
47+
| `CNB_TARGET_DISTRO_VERISON` | Target OS distribution version (optional) |
48+
49+
Buildpacks can use this information to modify their behavior depending on the target.
50+
51+
### Run image extensions is supported (experimental)
52+
53+
In Platform 0.12, extensions can be used to extend not only build-time base images, but runtime base images as well.
54+
55+
For more information, see [authoring an image extension](/docs/extension-guide/create-extension).

content/docs/reference/spec/migration/platform-api-0.3-0.4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When building, platforms can optionally specify the location of the report, or s
3030

3131
When interpreting the Bill-of-Materials (BOM), `version` [will no longer be found at the top level](https://github.com/buildpacks/spec/pull/117).
3232
The lifecycle will convert any `version` provided by buildpacks to `metadata.version`.
33-
Related: as of buildpack API 0.3, `version` is [deprecated](https://github.com/buildpacks/spec/pull/97) as a top-level key in the build plan.
33+
Related: as of Buildpack API 0.3, `version` is [deprecated](https://github.com/buildpacks/spec/pull/97) as a top-level key in the build plan.
3434

3535
### New exit code definition
3636

content/docs/reference/spec/migration/platform-api-0.9-0.10.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ See the [spec release](https://github.com/buildpacks/spec/releases/tag/platform%
1212

1313
### The `launcher` supports overridable process arguments
1414

15-
The way user-provided arguments are handled by the launcher depends on the buildpack API of the buildpack that created the process definition.
15+
The way user-provided arguments are handled by the launcher depends on the Buildpack API of the buildpack that created the process definition.
1616

1717
#### Newer buildpacks
1818

19-
Process types contributed by newer buildpacks (buildpack API 0.9 and above) may have overridable process arguments. Looking at metadata.toml:
19+
Process types contributed by newer buildpacks (Buildpack API 0.9 and above) may have overridable process arguments. Looking at metadata.toml:
2020
```
2121
[[processes]]
2222
type = "from-newer-buildpack"
@@ -40,7 +40,7 @@ will result in the following command invocation: `some-command always-1 always-2
4040

4141
#### Older buildpacks
4242

43-
Process types contributed by older buildpacks (buildpack API 0.8 and below) do not have overridable process arguments. Looking at metadata.toml:
43+
Process types contributed by older buildpacks (Buildpack API 0.8 and below) do not have overridable process arguments. Looking at metadata.toml:
4444
```
4545
[[processes]]
4646
type = "from-older-buildpack"

0 commit comments

Comments
 (0)