Merge branch 'main' into extensions-phase-2-rc2

Author: Natalie Arellano

.github/workflows/main.yml

@@ -38,9 +38,6 @@ jobs:
       - name: Check links
         run: |
           make check-links
-      - name: Check katacoda
-        run: |
-          make check-katacoda
       - name: Upload public folder
         uses: actions/upload-artifact@v3
         env:

config.toml

@@ -81,21 +81,6 @@ featureKatacoda = false
   url        = "https://github.com/buildpacks"
   weight     = 4
 
-  [[menu.docs]]
-  name       = "Application Developer Guide"
-  url        = "/docs/app-developer-guide"
-  weight     = 1
-
-  [[menu.docs]]
-  name       = "Buildpack Author Guide"
-  url        = "/docs/buildpack-author-guide"
-  weight     = 2
-
-  [[menu.docs]]
-  name       = "Platform Operator Guide"
-  url        = "/docs/operator-guide/"
-  weight     = 3
-
 [security]
   enableInlineShortcodes = false
   [security.exec]

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

@@ -38,14 +38,14 @@ Processes:
 
 Apart from the above standard metadata, buildpacks can also populate information about the dependencies they have provided in form of a `Bill-of-Materials`. Let's see how we can use this to populate information about the version of `ruby` that was installed in the output app image.
 
-To add the `ruby` version to the output of `pack download sbom`, we will have to provide a [Software `Bill-of-Materials`](https://en.wikipedia.org/wiki/Software_bill_of_materials) (`SBOM`) containing this information. There are three "standard" ways to report SBOM data.  You'll need to choose to use on of [CycloneDX](https://cyclonedx.org/), [SPDX](https://spdx.dev/) or [Syft](https://github.com/anchore/syft) update the `ruby.sbom.<ext>` (where `<ext>` is the extension appropriate for your SBOM standard, one of `cdx.json`, `spdx.json` or `syft.json`) at the end of your `build` script.  Discussion of which SBOM format to choose is outside the scope of this tutorial, but we will note that the SBOM format you choose to use is likely to be the output format of any SBOM scanner (eg: [`syft cli`](https://github.com/anchore/syft)) you might choose to use.  In this example we will use the CycloneDX json format.
+To add the `ruby` version to the output of `pack download sbom`, we will have to provide a [Software `Bill-of-Materials`](https://en.wikipedia.org/wiki/Software_bill_of_materials) (`SBOM`) containing this information. There are three "standard" ways to report SBOM data.  You'll need to choose to use one of [CycloneDX](https://cyclonedx.org/), [SPDX](https://spdx.dev/) or [Syft](https://github.com/anchore/syft) update the `ruby.sbom.<ext>` (where `<ext>` is the extension appropriate for your SBOM standard, one of `cdx.json`, `spdx.json` or `syft.json`) at the end of your `build` script.  Discussion of which SBOM format to choose is outside the scope of this tutorial, but we will note that the SBOM format you choose to use is likely to be the output format of any SBOM scanner (eg: [`syft cli`](https://github.com/anchore/syft)) you might choose to use.  In this example we will use the CycloneDX json format.
 
 First, annotate the `buildpack.toml` to specify that it emits CycloneDX:
 
 <!-- test:file=ruby-buildpack/buildpack.toml -->
 ```toml
 # Buildpack API version
-api = "0.7"
+api = "0.8"
 
 # Buildpack ID and metadata
 [buildpack]
@@ -141,11 +141,7 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 # Compares previous Gemfile.lock checksum to the current Gemfile.lock
 bundlerlayer="$layersdir/bundler"
 local_bundler_checksum=$((sha256sum Gemfile.lock || echo 'DOES_NOT_EXIST') | cut -d ' ' -f 1)
@@ -170,7 +166,7 @@ EOL
 
 fi
 
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 # our web process
 [[processes]]
@@ -185,7 +181,7 @@ command = "bundle exec ruby worker.rb"
 EOL
 
 # ========== ADDED ===========
-# 9. ADD A SBOM
+# 8. ADD A SBOM
 rubybom="${layersdir}/ruby.sbom.cdx.json"
 cat >> ${rubybom} << EOL
 {
@@ -237,7 +233,7 @@ The SBOM information is now downloaded to the local file system:
 cat layers/sbom/launch/examples_ruby/ruby/sbom.cdx.json | jq -M
 ```
 
-You should find that the included `ruby` version is `2.5.0` as expected.
+You should find that the included `ruby` version is `3.1.0` as expected.
 
 <!-- test:assert=contains;ignore-lines=... -->
 ```text
@@ -249,7 +245,7 @@ You should find that the included `ruby` version is `2.5.0` as expected.
     {
       "type": "library",
       "name": "ruby",
-      "version": "2.5.0"
+      "version": "3.1.0"
     },
 ...
   ]

content/docs/buildpack-author-guide/create-buildpack/build-app.md

@@ -40,7 +40,7 @@ Next, we'll download the Ruby runtime and install it into the layer directory. A
 <!-- file=ruby-buildpack/bin/build data-target=append -->
 ```bash
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 ```
 
@@ -67,9 +67,6 @@ Now we can install Bundler, a dependency manager for Ruby, and run the `bundle i
 
 <!-- file=ruby-buildpack/bin/build data-target=append -->
 ```bash
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
 echo "---> Installing gems"
 bundle install
 ```
@@ -97,7 +94,7 @@ mkdir -p "$rubylayer"
 
 # 3. DOWNLOAD RUBY
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 
 # 4. MAKE RUBY AVAILABLE DURING LAUNCH
@@ -107,11 +104,7 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 echo "---> Installing gems"
 bundle install
 ```
@@ -133,8 +126,6 @@ You will see the following output:
 ===> BUILDING
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby
----> Installing bundler
-...
 ---> Installing gems
 ...
 ===> EXPORTING

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

@@ -17,7 +17,7 @@ Example:
 <!-- test:exec -->
 ```bash
 pack buildpack new examples/ruby \
-    --api 0.7 \
+    --api 0.8 \
     --path ruby-buildpack \
     --version 0.0.1 \
     --stacks io.buildpacks.samples.stacks.bionic
@@ -41,7 +41,7 @@ You will have `ruby-buildpack/buildpack.toml`<!--+"{{open}}"+--> in your buildpa
 <!-- test:file=ruby-buildpack/buildpack.toml -->
 ```toml
 # Buildpack API version
-api = "0.7"
+api = "0.8"
 
 # Buildpack ID and metadata
 [buildpack]

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

@@ -45,7 +45,7 @@ mkdir -p "$rubylayer"
 
 # 3. DOWNLOAD RUBY
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 
 # 4. MAKE RUBY AVAILABLE DURING LAUNCH
@@ -55,19 +55,15 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
 # ======= MODIFIED =======
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 echo "---> Installing gems"
 bundlerlayer="$layersdir/bundler"
 mkdir -p "$bundlerlayer"
 echo -e '[types]\ncache = true\nlaunch = true' > "$layersdir/bundler.toml"
 bundle config set --local path "$bundlerlayer" && bundle install && bundle binstubs --all --path "$bundlerlayer/bin"
 
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 # our web process
 [[processes]]
@@ -196,7 +192,7 @@ mkdir -p "$rubylayer"
 
 # 3. DOWNLOAD RUBY
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 
 # 4. MAKE RUBY AVAILABLE DURING LAUNCH
@@ -206,12 +202,8 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
 # ======= MODIFIED =======
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 # Compares previous Gemfile.lock checksum to the current Gemfile.lock
 bundlerlayer="$layersdir/bundler"
 local_bundler_checksum=$((sha256sum Gemfile.lock || echo 'DOES_NOT_EXIST') | cut -d ' ' -f 1)
@@ -236,7 +228,7 @@ EOL
 
 fi
 
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 # our web process
 [[processes]]
@@ -266,8 +258,6 @@ it will download the gems:
 ===> BUILDING
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby
----> Installing bundler
-...
 ---> Installing gems
 ```
 
@@ -286,8 +276,6 @@ you will see the new caching logic at work during the `BUILDING` phase:
 ===> BUILDING
 ---> Ruby Buildpack
 ---> Downloading and extracting Ruby
----> Installing bundler
-...
 ---> Reusing gems
 ```
 

content/docs/buildpack-author-guide/create-buildpack/make-app-runnable.md

@@ -40,7 +40,7 @@ mkdir -p "$rubylayer"
 
 # 3. DOWNLOAD RUBY
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 
 # 4. MAKE RUBY AVAILABLE DURING LAUNCH
@@ -50,16 +50,12 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 echo "---> Installing gems"
 bundle install
 
 # ========== ADDED ===========
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 [[processes]]
 type = "web"

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

@@ -24,7 +24,7 @@ fi
 
 # ======= ADDED =======
 plan=$2
-version=2.5.1
+version=3.1.3
 
 if [[ -f .ruby-version ]]; then
     version=$(cat .ruby-version | tr -d '[:space:]')
@@ -69,11 +69,7 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 # Compares previous Gemfile.lock checksum to the current Gemfile.lock
 bundlerlayer="$layersdir/bundler"
 local_bundler_checksum=$((sha256sum Gemfile.lock || echo 'DOES_NOT_EXIST') | cut -d ' ' -f 1)
@@ -98,7 +94,7 @@ EOL
 
 fi
 
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 # our web process
 [[processes]]
@@ -117,7 +113,7 @@ Finally, create a file `ruby-sample-app/.ruby-version` with the following conten
 
 <!-- test:file=ruby-sample-app/.ruby-version -->
 ```
-2.5.0
+3.1.0
 ```
 
 Now when you run:
@@ -134,7 +130,7 @@ You will notice that version of Ruby specified in the app's `.ruby-version` file
 ```text
 ===> BUILDING
 ---> Ruby Buildpack
----> Downloading and extracting Ruby 2.5.0
+---> Downloading and extracting Ruby 3.1.0
 ```
 
 Next, let's see how buildpacks can store information about the dependencies provided in the output app image for introspection.

content/docs/buildpack-author-guide/create-buildpack/specify-multiple-process-types.md

@@ -57,7 +57,7 @@ mkdir -p "$rubylayer"
 
 # 3. DOWNLOAD RUBY
 echo "---> Downloading and extracting Ruby"
-ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-2.5.1.tgz
+ruby_url=https://s3-external-1.amazonaws.com/heroku-buildpack-ruby/heroku-18/ruby-3.1.3.tgz
 wget -q -O - "$ruby_url" | tar -xzf - -C "$rubylayer"
 
 # 4. MAKE RUBY AVAILABLE DURING LAUNCH
@@ -67,16 +67,12 @@ echo -e '[types]\nlaunch = true' > "$layersdir/ruby.toml"
 export PATH="$rubylayer"/bin:$PATH
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}"$rubylayer/lib"
 
-# 6. INSTALL BUNDLER
-echo "---> Installing bundler"
-gem install bundler --no-ri --no-rdoc
-
-# 7. INSTALL GEMS
+# 6. INSTALL GEMS
 echo "---> Installing gems"
 bundle install
 
 # ========== MODIFIED ===========
-# 8. SET DEFAULT START COMMAND
+# 7. SET DEFAULT START COMMAND
 cat > "$layersdir/launch.toml" << EOL
 # our web process
 [[processes]]

content/docs/buildpack-author-guide/publishing-with-github-actions.md

@@ -34,15 +34,15 @@ jobs:
     - ubuntu-latest
     steps:
     - id: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - if: ${{ github.event_name != 'pull_request' || ! github.event.pull_request.head.repo.fork }}
       uses: docker/login-action@v1
       with:
         registry: docker.io
         username: ${{ secrets.DOCKER_HUB_USER }}
         password: ${{ secrets.DOCKER_HUB_PASS }}
     - id: setup-pack
-      uses: buildpacks/github-actions/setup-pack@v4.4.0
+      uses: buildpacks/github-actions/setup-pack@v4.9.0
     - id: package
       run: |
         #!/usr/bin/env bash
@@ -59,7 +59,7 @@ jobs:
       env:
         REPO: docker.io/${{ secrets.DOCKER_HUB_USER }}
     - id: register
-      uses: docker://ghcr.io/buildpacks/actions/registry/request-add-entry:4.4.0
+      uses: docker://ghcr.io/buildpacks/actions/registry/request-add-entry:4.9.0
       with:
         token:   ${{ secrets.PUBLIC_REPO_TOKEN }}
         id:      ${{ steps.package.outputs.bp_id }}