Skip to content

Commit 6a3cf81

Browse files
authored
Merge branch 'main' into enhancement/issue-529-document-export-to-oci-layout
2 parents c944b90 + d8efffb commit 6a3cf81

39 files changed

+205
-130
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ build: $(HUGO_BIN) pack-version pack-docs-update
139139
.PHONY: test
140140
test: install-pack-cli check-pack-cli-version install-ugo
141141
@echo "> Testing..."
142-
ugo run -r -p ./content/docs/
142+
ugo run -v -r -p ./content/docs/
143143

144144
.PHONY: htmltest-install
145145
htmltest-install:

content/docs/app-developer-guide/build-an-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pack builder suggest
3131
```
3232
<!--+- "{{execute}}"+-->
3333

34-
For this guide we're actually going to use a sample builder, `cnbs/sample-builder:bionic`, which is not listed
34+
For this guide we're actually going to use a sample builder, `cnbs/sample-builder:jammy`, which is not listed
3535
as a suggested builder for good reason. It's a sample.
3636

3737
### 2. Build your app
@@ -47,12 +47,12 @@ ls samples || git clone https://github.com/buildpacks/samples
4747

4848
2. Build the app
4949
```
50-
pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:bionic
50+
pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:jammy
5151
```
5252
<!--+- "{{execute}}"+-->
5353

5454
> **TIP:** If you don't want to keep specifying a builder every time you build, you can set it as your default
55-
> builder by running `pack config default-builder <BUILDER>` for example `pack config default-builder cnbs/sample-builder:bionic`
55+
> builder by running `pack config default-builder <BUILDER>` for example `pack config default-builder cnbs/sample-builder:jammy`
5656
<!--+- "{{execute}}"+-->
5757
5858
### 3. Run it

content/docs/app-developer-guide/build-an-arm-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ docker run --rm \
7474
--volume ~/workspace/platform:/platform \
7575
--mount type=bind,source=~/workspace/order.toml,target=/cnb/order.toml \
7676
--env CNB_PLATFORM_API=0.7 \
77-
ubuntu:bionic \
78-
/cnb/lifecycle/creator -log-level debug -daemon -run-image ubuntu:bionic hello-arm64
77+
ubuntu:jammy \
78+
/cnb/lifecycle/creator -log-level debug -daemon -run-image ubuntu:jammy hello-arm64
7979
```
8080

8181
### 4. Run it

content/docs/app-developer-guide/building-on-podman.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ git clone https://github.com/buildpacks/samples
4747
![](https://i.imgur.com/0mmV6K7.png)
4848

4949
```shell=bash
50-
pack build sample-app -p samples/apps/ruby-bundler/ -B cnbs/sample-builder:bionic
50+
pack build sample-app -p samples/apps/ruby-bundler/ -B cnbs/sample-builder:jammy
5151
```
5252

5353
Where:

content/docs/app-developer-guide/environment-variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export FOO=BAR
3030
pack build sample-app \
3131
--env "HELLO=WORLD" \
3232
--env "FOO" \
33-
--builder cnbs/sample-builder:bionic \
33+
--builder cnbs/sample-builder:jammy \
3434
--buildpack samples/buildpacks/hello-world/ \
3535
--buildpack samples/apps/bash-script/bash-script-buildpack/ \
3636
--path samples/apps/bash-script/
@@ -76,7 +76,7 @@ echo -en "HELLO=WORLD\nFOO" > ./envfile
7676
```
7777
pack build sample-app \
7878
--env-file ./envfile \
79-
--builder cnbs/sample-builder:bionic \
79+
--builder cnbs/sample-builder:jammy \
8080
--buildpack samples/buildpacks/hello-world/ \
8181
--buildpack samples/apps/bash-script/bash-script-buildpack/ \
8282
--path samples/apps/bash-script/
@@ -122,7 +122,7 @@ EOL
122122
2. Build the app
123123
```
124124
pack build sample-app \
125-
--builder cnbs/sample-builder:bionic \
125+
--builder cnbs/sample-builder:jammy \
126126
--buildpack samples/buildpacks/hello-world/ \
127127
--buildpack samples/apps/bash-script/bash-script-buildpack/ \
128128
--path samples/apps/bash-script/

content/docs/app-developer-guide/mounting-volumes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Now, we can mount this volume during `pack build`:
8787
```bash
8888
ls -al
8989
pack build volume-example \
90-
--builder cnbs/sample-builder:bionic \
90+
--builder cnbs/sample-builder:jammy \
9191
--buildpack samples/buildpacks/hello-world \
9292
--path samples/apps/bash-script \
9393
--volume test-volume:/platform/volume:ro

content/docs/app-developer-guide/specify-buildpacks.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,24 +54,25 @@ pack build sample-java-maven-app \
5454

5555
## Using a Project Descriptor
5656

57-
The [`project.toml`][project-toml] format allows for Buildpack URIs to be specified in the `[[build.buildpacks]]` table with the `uri` key.
57+
The [`project.toml`][project-toml] format allows for Buildpack URIs to be specified in the `[[io.buildpacks.group]]` table with the `uri` key.
5858

5959
##### Example:
6060

6161
```toml
62-
[project]
62+
[_]
63+
schema-version = "0.3"
6364
id = "sample-java-maven-app"
6465
name = "Sample Java App"
6566
version = "1.0.0"
6667

67-
[[build.buildpacks]]
68+
[[io.buildpacks.group]]
6869
uri = "samples/java-maven"
6970

70-
[[build.buildpacks]]
71+
[[io.buildpacks.group]]
7172
uri = "samples/buildpacks/hello-processes/"
7273

73-
[[build.buildpacks]]
74-
uri = "docker://cnbs/sample-package:hello-univers"
74+
[[io.buildpacks.group]]
75+
uri = "docker://cnbs/sample-package:hello-universe"
7576
```
7677

7778
## URI Examples

content/docs/app-developer-guide/using-cache-image.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ For the following examples we will use:
2929
> **NOTE:** If we wish to publish to an external registry like `Dockerhub` we will first need to authenticate with `docker` to allow us to push images. We can do this via `docker login`
3030
3131

32-
Next we trust the `cnbs/sample-builder:bionic` builder in order to allow access to docker credentials when publishing.
32+
Next we trust the `cnbs/sample-builder:jammy` builder in order to allow access to docker credentials when publishing.
3333

3434
```
35-
pack config trusted-builders add cnbs/sample-builder:bionic
35+
pack config trusted-builders add cnbs/sample-builder:jammy
3636
```
3737
<!--+- "{{execute}}"+-->
3838

@@ -42,7 +42,7 @@ To build the `localhost:5000/buildpack-examples/cache-image-example` application
4242

4343
```
4444
pack build localhost:5000/buildpack-examples/cache-image-example \
45-
--builder cnbs/sample-builder:bionic \
45+
--builder cnbs/sample-builder:jammy \
4646
--buildpack samples/java-maven \
4747
--path samples/apps/java-maven \
4848
--cache-image localhost:5000/buildpack-examples/maven-cache-image:latest \
@@ -76,7 +76,7 @@ builds may also update the specified `cache-image`.
7676
The following command will restore data for the `samples/java-maven:maven_m2` layer from the cache image.
7777
```
7878
pack build localhost:5000/buildpack-examples/second-cache-image-example \
79-
--builder cnbs/sample-builder:bionic \
79+
--builder cnbs/sample-builder:jammy \
8080
--buildpack samples/java-maven \
8181
--path samples/apps/java-maven \
8282
--cache-image localhost:5000/buildpack-examples/maven-cache-image:latest \

content/docs/app-developer-guide/using-http-proxy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ We show how to solve both of these constraints.
1616
You may need the `pack` command-line tool to download buildpacks and images via your proxy. Building an application with an incorrectly configured proxy results in errors such as the following:
1717

1818
```console
19-
$ pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:bionic
20-
ERROR: failed to build: failed to fetch builder image 'index.docker.io/cnbs/sample-builder:bionic'
19+
$ pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:jammy
20+
ERROR: failed to build: failed to fetch builder image 'index.docker.io/cnbs/sample-builder:jammy'
2121
: Error response from daemon: Get "https//registry-1.docker.io/v2/": context deadline exceeded
2222
```
2323

@@ -37,7 +37,7 @@ Buildpacks may also need to be aware of your http and https proxies at build tim
3737
```console
3838
export http_proxy=http://user:[email protected]:3128
3939
export https_proxy=https://my-proxy.example.com:3129
40-
pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:bionic
40+
pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:jammy
4141
```
4242

4343
## Making your Application Proxy Aware

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,23 @@ summary="Learn how to create an ephemeral buildpack to customize your build."
66

77
You can supplement your app's build process with custom scripts by creating an _inline buildpack_. An inline buildpack is an ephemeral buildpack that's defined in your [project descriptor][project-toml] (i.e. `project.toml`). You can include a script to run as part of the build without setting up all the files and directories that are required for a complete buildpack.
88

9-
Inline buildpacks are defined as an entry in the `[[build.buildpacks]]` table of the project descriptor by including an `inline` script in the `[build.buildpacks.script]` table.
9+
Inline buildpacks are defined as an entry in the `[[io.buildpacks.group]]` table of the project descriptor by including an `inline` script in the `[io.buildpacks.group.script]` table.
1010

1111
For example, you may want to run a Rake task against a Ruby app after the Ruby buildpack builds your app.
1212

1313
```toml
14-
[project]
14+
[_]
15+
schema-version = "0.2"
1516
id = "io.buildpacks.my-app"
1617

17-
[[build.buildpacks]]
18+
[[io.buildpacks.group]]
1819
id = "example/ruby"
1920
version = "1.0"
2021

21-
[[build.buildpacks]]
22+
[[io.buildpacks.group]]
2223
id = "me/rake-tasks"
2324

24-
[build.buildpacks.script]
25+
[io.buildpacks.group.script]
2526
api = "0.6"
2627
inline = "rake package"
2728
```
@@ -33,10 +34,10 @@ In this example, the `me/rake-tasks` inline buildpack is configured to run after
3334
Inline buildpacks aren't constrained to a single command, however. You can define complex scripts as [heredocs](https://toml.io/en/v1.0.0#string) in your project descriptor. For example, this snippet of a descriptor will source a shell script contained in the app repo, use it to modify the app directory (and thus the files that go into the final image), and create slices for the app:
3435

3536
```toml
36-
[[build.buildpacks]]
37+
[[io.buildpacks.group]]
3738
id = "me/cleanup"
3839

39-
[build.buildpacks.script]
40+
[io.buildpacks.script]
4041
api = "0.9"
4142
inline = """
4243
set -e

0 commit comments

Comments
 (0)