Skip to content

Commit 550a987

Browse files
authored
Merge branch 'main' into enhancement/issue-529-document-export-to-oci-layout
2 parents 8292b0e + 77adc63 commit 550a987

36 files changed

+644
-425
lines changed

.github/workflows/main.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ jobs:
1818
- name: Git Checkout
1919
uses: actions/checkout@v3
2020
- name: Setup Go environment
21-
uses: actions/setup-go@v3
21+
uses: actions/setup-go@v4
2222
with:
2323
go-version: '1.x'
2424
- name: Install Dependencies
2525
run: sudo apt-get install make curl jq
2626
- name: Install pack
27-
uses: buildpacks/github-actions/setup-pack@v5.0.1
27+
uses: buildpacks/github-actions/setup-pack@v5.2.0
2828
with:
29-
pack-version: '0.28.0'
29+
pack-version: '0.30.0-rc1' # FIXME: update to 0.30.0 when available
3030
- name: Test
3131
run: make test
3232
env:

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Base Image:
5050
Run Images:
5151
cnbs/sample-stack-run:alpine
5252
53+
Rebasable: true
54+
5355
Buildpacks:
5456
ID VERSION HOMEPAGE
5557
samples/java-maven 0.0.1 https://github.com/buildpacks/samples/tree/main/buildpacks/java-maven

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ summary="Learn how to specify exactly what buildpacks are used during the build
99

1010
You may specify exactly what buildpacks are used during the build process by referencing them with a URI in any of the following formats.
1111

12-
| Type | Format |
13-
|----- |------- |
14-
| Relative | `<path>` |
15-
| Filesystem | `file://[<host>]/<path>` |
16-
| URL | `http[s]://<host>/<path>` |
17-
| Docker | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
18-
| CNB Builder Resource | `urn:cnb:builder[:<id>[@<version>]]` |
19-
| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]` |
12+
| Type | Format |
13+
| --------------------- | -------------------------------------------- |
14+
| Relative | `<path>` |
15+
| Filesystem | `file://[<host>]/<path>` |
16+
| URL | `http[s]://<host>/<path>` |
17+
| Docker | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
18+
| CNB Builder Resource | `urn:cnb:builder[:<id>[@<version>]]` |
19+
| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]` |
2020

2121
##### Fallback Behavior
2222

@@ -60,7 +60,7 @@ The [`project.toml`][project-toml] format allows for Buildpack URIs to be specif
6060

6161
```toml
6262
[_]
63-
schema-version = "0.3"
63+
schema-version = "0.2"
6464
id = "sample-java-maven-app"
6565
name = "Sample Java App"
6666
version = "1.0.0"

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,12 @@ pack build localhost:5000/buildpack-examples/second-cache-image-example \
8585
```
8686
<!--+- "{{execute}}"+-->
8787

88+
### Image Retention
89+
90+
Managing the lifecycle of images should be the responsibility of the owner, as `the platform does not automatically clean up old images from the registry`.
91+
You can refer to your registry's documentation to learn how to accomplish this.
92+
* [AWS ECR](https://aws.amazon.com/ecr/) users can find information on how to delete images in the AWS ECR documentation, specifically in the section on [image deletion](https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html).
93+
* [Docker](https://docs.docker.com/engine/) users can consult the Docker documentation on [Advanced Image Management](https://docs.docker.com/docker-hub/image-management/) to find out how to delete images.
94+
95+
8896
[samples]: https://github.com/buildpack/samples

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Inline buildpacks aren't constrained to a single command, however. You can defin
3737
[[io.buildpacks.group]]
3838
id = "me/cleanup"
3939

40-
[io.buildpacks.script]
40+
[io.buildpacks.group.script]
4141
api = "0.9"
4242
inline = """
4343
set -e

content/docs/app-developer-guide/using-project-descriptor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ file at the root of the application. For more on `gitignore` matching see [these
2020

2121
```toml
2222
[_]
23+
schema-version = "0.2"
2324
id = "io.buildpacks.bash-script"
2425
name = "Bash Script"
2526
version = "1.0.0"
@@ -68,6 +69,7 @@ Below is an expanded `project.toml`, with an additional buildpack and environmen
6869

6970
```toml
7071
[_]
72+
schema-version = "0.2"
7173
id = "io.buildpacks.bash-script"
7274
name = "Bash Script"
7375
version = "1.0.0"

content/docs/buildpack-author-guide/create-buildpack/adding-bill-of-materials.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ One of the benefits of buildpacks is they can also populate the app image with m
1010
* The process types that are available and the commands associated with them
1111
* The run-image the app image was based on
1212
* The buildpacks were used to create the app image
13+
* Whether the run-image can be rebased with a new version through the `Rebasable` label or not
1314
* And more...!
1415

1516
You can find some of this information using `pack` via its `inspect-image` command. The bill-of-materials information will be available using `pack sbom download`.
@@ -21,10 +22,11 @@ pack inspect-image test-ruby-app
2122
<!--+- "{{execute}}"+-->
2223
You should see the following:
2324

24-
<!-- test:assert=contains -->
25+
<!-- test:assert=contains;ignore-lines=... -->
2526
```text
2627
Run Images:
2728
cnbs/sample-stack-run:jammy
29+
...
2830
2931
Buildpacks:
3032
ID VERSION HOMEPAGE

content/docs/buildpack-author-guide/create-buildpack/building-blocks-cnb.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,12 @@ The `pack build` command takes in your Ruby sample app as the `--path` argument
116116

117117
After running the command, you should see that it failed to detect, as the `detect` script is currently written to simply error out.
118118

119-
<!-- test:assert=contains -->
119+
<!-- test:assert=contains;ignore-lines=... -->
120120
```
121121
===> DETECTING
122+
...
122123
err: examples/[email protected] (1)
124+
...
123125
ERROR: No buildpack groups passed detection.
124126
ERROR: failed to detect: buildpack(s) failed with err
125127
```

content/docs/buildpack-author-guide/create-buildpack/caching.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ it will download the gems:
256256
<!-- test:assert=contains;ignore-lines=... -->
257257
```text
258258
===> BUILDING
259+
...
259260
---> Ruby Buildpack
260261
---> Downloading and extracting Ruby
261262
---> Installing gems
@@ -274,6 +275,7 @@ you will see the new caching logic at work during the `BUILDING` phase:
274275
<!-- test:assert=contains;ignore-lines=... -->
275276
```text
276277
===> BUILDING
278+
...
277279
---> Ruby Buildpack
278280
---> Downloading and extracting Ruby
279281
---> Reusing gems

content/docs/buildpack-author-guide/create-buildpack/make-buildpack-configurable.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,10 @@ pack build test-ruby-app --path ./ruby-sample-app --buildpack ./ruby-buildpack
126126
127127
You will notice that version of Ruby specified in the app's `.ruby-version` file is downloaded.
128128
129-
<!-- test:assert=contains -->
129+
<!-- test:assert=contains;ignore-lines=... -->
130130
```text
131131
===> BUILDING
132+
...
132133
---> Ruby Buildpack
133134
---> Downloading and extracting Ruby 3.1.0
134135
```

0 commit comments

Comments
 (0)