Merge branch 'main' into 1799-pack-inspect

Signed-off-by: Natalie Arellano <[email protected]>

Author: Natalie Arellano

.github/workflows/main.yml

@@ -18,15 +18,15 @@ jobs:
       - name: Git Checkout
         uses: actions/checkout@v3
       - name: Setup Go environment
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: '1.x'
       - name: Install Dependencies
         run: sudo apt-get install make curl jq
       - name: Install pack
         uses: buildpacks/github-actions/[email protected]
         with:
-          pack-version: '0.28.0'
+          pack-version: '0.30.0-rc1'
       - name: Test
         run: make test
         env:

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

@@ -9,14 +9,14 @@ summary="Learn how to specify exactly what buildpacks are used during the build
 
 You may specify exactly what buildpacks are used during the build process by referencing them with a URI in any of the following formats.
 
-| Type | Format |
-|----- |------- |
-| Relative | `<path>` |
-| Filesystem | `file://[<host>]/<path>` |
-| URL | `http[s]://<host>/<path>` |
-| Docker | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
-| CNB Builder Resource | `urn:cnb:builder[:<id>[@<version>]]` |
-| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]` |
+| Type                  | Format                                       |
+| --------------------- | -------------------------------------------- |
+| Relative              | `<path>`                                     |
+| Filesystem            | `file://[<host>]/<path>`                     |
+| URL                   | `http[s]://<host>/<path>`                    |
+| Docker                | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
+| CNB Builder Resource  | `urn:cnb:builder[:<id>[@<version>]]`         |
+| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]`        |
 
 ##### Fallback Behavior
 
@@ -60,7 +60,7 @@ The [`project.toml`][project-toml] format allows for Buildpack URIs to be specif
 
 ```toml
 [_]
-schema-version = "0.3"
+schema-version = "0.2"
 id = "sample-java-maven-app"
 name = "Sample Java App"
 version = "1.0.0"

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

@@ -20,6 +20,7 @@ file at the root of the application. For more on `gitignore` matching see [these
 
 ```toml
 [_]
+schema-version = "0.2"
 id = "io.buildpacks.bash-script"
 name = "Bash Script"
 version = "1.0.0"
@@ -68,6 +69,7 @@ Below is an expanded `project.toml`, with an additional buildpack and environmen
 
 ```toml
 [_]
+schema-version = "0.2"
 id = "io.buildpacks.bash-script"
 name = "Bash Script"
 version = "1.0.0"

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

@@ -22,12 +22,11 @@ pack inspect-image test-ruby-app
 <!--+- "{{execute}}"+-->
 You should see the following:
 
-<!-- test:assert=contains -->
+<!-- test:assert=contains;ignore-lines=... -->
 ```text
 Run Images:
   cnbs/sample-stack-run:jammy
-  
-Rebasable: true
+...
 
 Buildpacks:
   ID                   VERSION        HOMEPAGE

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

@@ -116,10 +116,12 @@ The `pack build` command takes in your Ruby sample app as the `--path` argument
 
 After running the command, you should see that it failed to detect, as the `detect` script is currently written to simply error out.
 
-<!-- test:assert=contains -->
+<!-- test:assert=contains;ignore-lines=... -->
 ```
 ===> DETECTING
+...
 err:  examples/[email protected] (1)
+...
 ERROR: No buildpack groups passed detection.
 ERROR: failed to detect: buildpack(s) failed with err
 ```

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

@@ -256,6 +256,7 @@ it will download the gems:
 <!-- test:assert=contains;ignore-lines=... -->
 ```text
 ===> BUILDING
+...
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby
 ---> Installing gems
@@ -274,6 +275,7 @@ you will see the new caching logic at work during the `BUILDING` phase:
 <!-- test:assert=contains;ignore-lines=... -->
 ```text
 ===> BUILDING
+...
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby
 ---> Reusing gems

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

@@ -126,9 +126,10 @@ pack build test-ruby-app --path ./ruby-sample-app --buildpack ./ruby-buildpack
 
 You will notice that version of Ruby specified in the app's `.ruby-version` file is downloaded.
 
-<!-- test:assert=contains -->
+<!-- test:assert=contains;ignore-lines=... -->
 ```text
 ===> BUILDING
+...
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby 3.1.0
 ```

content/docs/extension-guide/create-extension/build-dockerfile.md

@@ -8,52 +8,34 @@ aliases = [
 
 <!-- test:suite=dockerfiles;weight=4 -->
 
-### Examine `tree` extension
+### Examine `vim` extension
 
 #### detect
 
 <!-- test:exec -->
 ```bash
-cat $PWD/samples/extensions/tree/bin/detect
+cat $PWD/samples/extensions/vim/bin/detect
 ```
 
-The extension always detects (because its exit code is `0`) and provides a dependency called `tree` by writing to the build plan.
+The extension always detects (because its exit code is `0`) and provides a dependency called `vim` by writing to the build plan.
 
 #### generate
 
 <!-- test:exec -->
 ```bash
-cat $PWD/samples/extensions/tree/bin/generate
+cat $PWD/samples/extensions/vim/bin/generate
 ```
 
-The extension generates a `build.Dockerfile` that installs `tree` on the builder image.
-
-### Re-create our builder with `hello-extensions` updated to require `tree`
-
-Edit `$PWD/samples/buildpacks/hello-extensions/bin/detect` to uncomment the first set of lines that output `[[requires]]` to the build plan:
-
-<!-- test:exec -->
-```bash
-sed -i "10,11s/#//" $PWD/samples/buildpacks/hello-extensions/bin/detect
-```
-
-(On Mac, use `sed -i '' "10,11s/#//" $PWD/samples/buildpacks/hello-extensions/bin/detect`)
-
-Re-create the builder:
-
-<!-- test:exec -->
-```
-pack builder create localhost:5000/extensions-builder \
-  --config $PWD/samples/builders/alpine/builder.toml \
-  --publish
-```
+The extension generates a `build.Dockerfile` that installs `vim` on the builder image.
 
 ### Re-build the application image
 
 <!-- test:exec -->
 ```
 pack build hello-extensions \
   --builder localhost:5000/extensions-builder \
+  --env BP_EXT_DEMO=1 \
+  --env BP_REQUIRES=vim \
   --network host \
   --path $PWD/samples/apps/java-maven \
   --pull-policy always \
@@ -66,19 +48,19 @@ You should see:
 
 ```
 [detector] ======== Results ========
-[detector] pass: samples/tree@0.0.1
+[detector] pass: samples/vim@0.0.1
 [detector] pass: samples/[email protected]
 [detector] Resolving plan... (try #1)
-[detector] samples/tree             0.0.1
+[detector] samples/vim             0.0.1
 [detector] samples/hello-extensions 0.0.1
-[detector] Running generate for extension samples/tree@0.0.1
+[detector] Running generate for extension samples/vim@0.0.1
 ...
-[extender] Found build Dockerfile for extension 'samples/tree'
-[extender] Applying the Dockerfile at /layers/generated/build/samples_tree/Dockerfile...
+[extender] Found build Dockerfile for extension 'samples/vim'
+[extender] Applying the Dockerfile at /layers/generated/build/samples_vim/Dockerfile...
 ...
 [extender] Running build command
 [extender] ---> Hello Extensions Buildpack
-[extender] tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
+[extender] vim v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
 ...
 Successfully built image hello-extensions
 ```

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

@@ -8,11 +8,11 @@ aliases = [
 
 <!-- test:suite=dockerfiles;weight=3 -->
 
-### Examine `tree` extension
+### Examine `vim` extension
 
 <!-- test:exec -->
 ```bash
-tree $PWD/samples/extensions/tree
+vim --help
 ```
 
 (That's right, we're using the very tool we will later be installing!) You should see something akin to the following:
@@ -27,7 +27,7 @@ tree $PWD/samples/extensions/tree
 
 * The `extension.toml` describes the extension, containing information such as its name, ID, and version, as well as the
   buildpack API that it implements. Though extensions are not buildpacks, they are expected to conform to the buildpack
-  API except where noted. Consult the [spec](https://github.com/buildpacks/spec/blob/buildpack/main/image_extension.md)
+  API except where noted. Consult the [spec](https://github.com/buildpacks/spec/blob/main/image_extension.md)
   for further details.
 * `./bin/detect` is invoked during the `detect` phase. It analyzes application source code to determine if the extension
   is needed and contributes [build plan](/docs/reference/spec/buildpack-api/#build-plan) entries (much like a
@@ -36,15 +36,15 @@ tree $PWD/samples/extensions/tree
 * `./bin/generate` is invoked during the `generate` phase (a new lifecycle phase that happens after `detect`). It
   outputs either or both of `build.Dockerfile` or `run.Dockerfile` for extending the builder or run image, respectively.
   * Only a limited set of Dockerfile instructions is supported - consult
-    the [spec](https://github.com/buildpacks/spec/blob/buildpack/main/image_extension.md)
+    the [spec](https://github.com/buildpacks/spec/blob/main/image_extension.md)
     for further details.
   * In the [initial implementation](/docs/features/dockerfiles#phased-approach), `run.Dockerfile` instructions are
     limited to a single `FROM` instruction (effectively, it is only possible to switch the run-time base image to a
     pre-created image i.e., no dynamic image modification is allowed). Consult
-    the [spec](https://github.com/buildpacks/spec/blob/buildpack/main/image_extension.md)
+    the [spec](https://github.com/buildpacks/spec/blob/main/image_extension.md)
     for further details.
 
-We'll take a closer look at the executables for the `tree` extension in the next step.
+We'll take a closer look at the executables for the `vim` extension in the next step.
 
 <!--+ if false+-->
 ---

content/docs/extension-guide/create-extension/run-dockerfile.md

@@ -45,27 +45,7 @@ Build the run image:
 ```bash
 docker build \
   --file $PWD/samples/stacks/alpine/run/curl.Dockerfile \
-  --tag run-image-curl .
-```
-
-### Re-create our builder with `hello-extensions` updated to require `curl`
-
-Edit `$PWD/samples/buildpacks/hello-extensions/bin/detect` to uncomment the second set of lines that output `[[requires]]` to the build plan:
-
-<!-- test:exec -->
-```bash
-sed -i "14,15s/#//" $PWD/samples/buildpacks/hello-extensions/bin/detect
-```
-
-(On Mac, use `sed -i '' "14,15s/#//" $PWD/samples/buildpacks/hello-extensions/bin/detect`)
-
-Re-create the builder:
-
-<!-- test:exec -->
-```bash
-pack builder create localhost:5000/extensions-builder \
-  --config $PWD/samples/builders/alpine/builder.toml \
-  --publish
+  --tag localhost:5000/run-image-curl .
 ```
 
 ### Re-build the application image
@@ -74,6 +54,8 @@ pack builder create localhost:5000/extensions-builder \
 ```bash
 pack build hello-extensions \
   --builder localhost:5000/extensions-builder \
+  --env BP_EXT_DEMO=1 \
+  --env BP_REQUIRES=vim,curl \
   --path $PWD/samples/apps/java-maven \
   --pull-policy always \
   --network host \
@@ -86,26 +68,26 @@ You should see:
 
 ```
 [detector] ======== Results ========
-[detector] pass: samples/tree@0.0.1
+[detector] pass: samples/vim@0.0.1
 [detector] pass: samples/[email protected]
 [detector] pass: samples/[email protected]
 [detector] Resolving plan... (try #1)
-[detector] samples/tree             0.0.1
+[detector] samples/vim             0.0.1
 [detector] samples/curl             0.0.1
 [detector] samples/hello-extensions 0.0.1
-[detector] Running generate for extension samples/tree@0.0.1
+[detector] Running generate for extension samples/vim@0.0.1
 ...
 [detector] Running generate for extension samples/[email protected]
 ...
 [detector] Checking for new run image
 [detector] Found a run.Dockerfile configuring image 'run-image-curl' from extension with id 'samples/curl'
 ...
-[extender] Found build Dockerfile for extension 'samples/tree'
-[extender] Applying the Dockerfile at /layers/generated/build/samples_tree/Dockerfile...
+[extender] Found build Dockerfile for extension 'samples/vim'
+[extender] Applying the Dockerfile at /layers/generated/build/samples_vim/Dockerfile...
 ...
 [extender] Running build command
 [extender] ---> Hello Extensions Buildpack
-[extender] tree v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
+[extender] vim v1.8.0 (c) 1996 - 2018 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro
 ...
 Successfully built image hello-extensions
 ```
@@ -123,16 +105,16 @@ You should see something akin to:
 curl 7.85.0-DEV (x86_64-pc-linux-musl) ... more stuff here ...
 ```
 
-What happened: now that `hello-extensions` requires both `tree` and `curl` in its build plan, both extensions are
+What happened: now that `hello-extensions` requires both `vim` and `curl` in its build plan, both extensions are
   included in the build and provide the needed dependencies for build and launch, respectively
-* The `tree` extension installs `tree` at build time, as before
+* The `vim` extension installs `vim` at build time, as before
 * The `curl` extension switches the run image to `run-image-curl`, which has `curl` installed
 
 Now our `curl` process can succeed!
 
 ## What's next?
 
-The `tree` and `curl` examples are very simple, but we can unlock powerful new features with this functionality.
+The `vim` and `curl` examples are very simple, but we can unlock powerful new features with this functionality.
 
 Platforms could have several run images available, each tailored to a specific language family, thus limiting the number
 of installed dependencies for each image to the minimum necessary to support the targeted language. Image extensions