Merge branch 'main' into app-metadata

buildpacks · Mar 6, 2024 · 6e93ab3 · 6e93ab3
2 parents 9315573 + ce8991b
commit 6e93ab3
Show file tree

Hide file tree

Showing 134 changed files with 5,872 additions and 138 deletions.
diff --git a/.github/ISSUE_TEMPLATE/tracking.md b/.github/ISSUE_TEMPLATE/tracking.md
@@ -0,0 +1,35 @@
+---
+name: Tracking Issue
+about: Open an issue to track progress toward implementation of a merged RFC
+title: '[RFC #<INSERT RFC NUMBER - e.g., 0099>] - <INSERT RFC TITLE>'
+labels: type/tracking
+assignees: ''
+
+---
+
+[RFC #<INSERT RFC NUMBER - e.g., 0099>](https://github.com/buildpacks/rfcs/blob/main/text/<INSERT FILENAME>) - <INSERT RFC TITLE>
+
+Spec:
+- [ ] https://github.com/buildpacks/spec/issues/<INSERT ISSUE NUMBER>
+- [ ] Released in <INSERT API - e.g., platform> API version `<placeholder>`
+
+Lifecycle:
+- [ ] https://github.com/buildpacks/lifecycle/issues/<INSERT ISSUE NUMBER>
+- [ ] Released in lifecycle version `<placeholder>`
+
+Libcnb:
+- [ ] https://github.com/buildpacks/libcnb/issues/<INSERT ISSUE NUMBER>
+- [ ] Released in libcnb version `<placeholder>`
+
+Pack:
+- [ ] https://github.com/buildpacks/pack/issues/<INSERT ISSUE NUMBER>
+- [ ] Released in pack version `<placeholder>`
+
+Documentation:
+- [ ] https://github.com/buildpacks/docs/issues/<INSERT ISSUE NUMBER>
+
+<INSERT OTHER REPO>:
+- [ ] <INSERT ISSUE URL>
+- [ ] Released in <INSERT COMPONENT> version `<placeholder>`
+
+**Maintainers**: when closing this issue as completed, submit a PR to update the `Status` of the RFC to `Implemented`.
diff --git a/.github/auto-assign-bat.yml b/.github/auto-assign-bat.yml
@@ -8,3 +8,4 @@ filterLabels:
 assignees:
 - ekcasey
 - hone
+- samj1912
diff --git a/.github/workflows/auto-assign-maintainer.yml b/.github/workflows/auto-assign-maintainer.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on:
     - ubuntu-latest
     steps:
-    - uses: kentaro-m/[email protected].1
+    - uses: kentaro-m/[email protected].5
       with:
         configuration-path: .github/auto-assign-core.yml
   distribution:
@@ -23,7 +23,7 @@ jobs:
     runs-on:
     - ubuntu-latest
     steps:
-    - uses: kentaro-m/[email protected].1
+    - uses: kentaro-m/[email protected].5
       with:
         configuration-path: .github/auto-assign-distribution.yml
   implementation:
@@ -32,7 +32,7 @@ jobs:
     runs-on:
     - ubuntu-latest
     steps:
-    - uses: kentaro-m/[email protected].1
+    - uses: kentaro-m/[email protected].5
       with:
         configuration-path: .github/auto-assign-implementation.yml
   learning:
@@ -41,7 +41,7 @@ jobs:
     runs-on:
     - ubuntu-latest
     steps:
-    - uses: kentaro-m/[email protected].1
+    - uses: kentaro-m/[email protected].5
       with:
         configuration-path: .github/auto-assign-learning.yml
   platform:
@@ -50,7 +50,7 @@ jobs:
     runs-on:
     - ubuntu-latest
     steps:
-    - uses: kentaro-m/[email protected].1
+    - uses: kentaro-m/[email protected].5
       with:
         configuration-path: .github/auto-assign-platform.yml
   bat:
@@ -59,6 +59,6 @@ jobs:
     runs-on:
       - ubuntu-latest
     steps:
-      - uses: kentaro-m/[email protected].1
+      - uses: kentaro-m/[email protected].5
         with:
           configuration-path: .github/auto-assign-bat.yml
diff --git a/.github/workflows/issues-generation.yml b/.github/workflows/issues-generation.yml
@@ -15,7 +15,7 @@ jobs:
     if: ${{ github.event.issue.pull_request || github.event.pull_request }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Run Issue Generation
         uses: jromero/[email protected]
         id: issues-generation

diff --git a/0000-template.md b/0000-template.md
@@ -44,6 +44,11 @@ This is the technical portion of the RFC, where you explain the design in suffic
 
 The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.
 
+# Migration
+[migration]: #migration
+
+This section should document breaks to public API and breaks in compatibility due to this RFC's proposed changes. In addition, it should document the proposed steps that one would need to take to work through these changes. Care should be give to include all applicable personas, such as platform developers, buildpack developers, buildpack users and consumers of buildpack images.
+
 # Drawbacks
 [drawbacks]: #drawbacks
 
@@ -73,3 +78,24 @@ Discuss prior art, both the good and bad.
 Does this RFC entail any proposed changes to the core specifications or extensions? If so, please document changes here.
 Examples of a spec. change might be new lifecycle flags, new `buildpack.toml` fields, new fields in the buildpackage label, etc.
 This section is not intended to be binding, but as discussion of an RFC unfolds, if spec changes are necessary, they should be documented here.
+
+# History
+[history]: #history
+
+<!--
+## Amended
+### Meta
+[meta-1]: #meta-1
+- Name: (fill in the amendment name: Variable Rename)
+- Start Date: (fill in today's date: YYYY-MM-DD)
+- Author(s): (Github usernames)
+- Amendment Pull Request: (leave blank)
+
+### Summary
+
+A brief description of the changes.
+
+### Motivation
+
+Why was this amendment necessary?
+--->
diff --git a/README.md b/README.md
@@ -45,12 +45,13 @@ Once an RFC has been accepted, the sub-team maintainers should:
 Once an `issues-created/<sub-team>` label has been created for each sub-team, the RFC is ready to merge. The team member who merges the pull request should do the following:
 
 1. Assign an id based off the pull request number.
-1. Rename the file based off the ID inside `text/`.
-1. Fill in the remaining metadata at the top.
-1. Commit everything.
-1. Update issues with RFC ID and a link to the text file.
-1. Update any links in PR description to point at the committed file.
-1. Remove the "Final Comment Period" label.
+2. Rename the file based off the ID inside `text/`.
+3. Fill in the remaining metadata at the top.
+4. Commit everything.
+5. Update issues with RFC ID and a link to the text file.
+6. Update any links in PR description to point at the committed file.
+7. Remove the "status/voting" label.
+8. Create a [tracking issue](https://github.com/buildpacks/rfcs/issues/new?assignees=&labels=type%2Ftracking&template=tracking.md&title=%5BRFC+%23%3CINSERT+RFC+NUMBER+-+e.g.%2C+0099%3E%5D+-+%3CINSERT+RFC+TITLE%3E).
 
 ## Automation
 
@@ -60,4 +61,6 @@ The `merge-rfc.sh` script automates several steps of the merge process for accep
 ```
 Each `<issue>` should be of the form `<org>/<repo>#<number>` (e.g. `buildpacks/spec#1`). In the rare case that no work must be done in the project as a result of the RFC pass the `-n` flag to explicitly indicate that no issues should be linked.
 
-After running the `merge-rfc.sh` script, manually verify the output before pushing changes.
+After running the `merge-rfc.sh` script:
+* Manually verify the output before pushing changes.
+* Create a [tracking issue](https://github.com/buildpacks/rfcs/issues/new?assignees=&labels=type%2Ftracking&template=tracking.md&title=%5BRFC+%23%3CINSERT+RFC+NUMBER+-+e.g.%2C+0099%3E%5D+-+%3CINSERT+RFC+TITLE%3E).
diff --git a/merge-rfc.sh b/merge-rfc.sh
@@ -55,7 +55,7 @@ require_command issues-generation
 if [[ -z "${GITHUB_TOKEN:-}" ]]; then
   require_command op
   echo "> Pulling GitHub token from vault..."
-  GITHUB_TOKEN=$(op get item 7xorpxvz3je3vozqg3fy3wrcg4 --vault "Shared" --account buildpacks | jq -r '.details.sections[] | select(.fields).fields[] | select(.t == "credential").v')
+  GITHUB_TOKEN=$(op read op://Shared/7xorpxvz3je3vozqg3fy3wrcg4/credential --account buildpacks)
 fi
 
 ####
@@ -146,7 +146,7 @@ if [[ "$OSTYPE" == "darwin"* ]]; then
 fi
 sed $SEDOPTION "s|- RFC Pull Request:.*|- RFC Pull Request: [${REPO}#${PR_NUMBER}](https://github.com/${OWNER}/${REPO}/pull/${PR_NUMBER})|" "${SOURCE_DOC}"
 sed $SEDOPTION "s|- CNB Issue:.*|- CNB Issue: $ISSUES_TEXT|" "${SOURCE_DOC}"
-sed $SEDOPTION "s|- State:.*|- State: **Approved**|" "${SOURCE_DOC}"
+sed $SEDOPTION "s|- Status:.*|- Status: Approved|" "${SOURCE_DOC}"
 
 echo "> Moving ${SOURCE_DOC} to ${TARGET_DOC}..."
 git mv "${SOURCE_DOC}" "${TARGET_DOC}"

diff --git a/text/0001-pack-suggest-stacks.md b/text/0001-pack-suggest-stacks.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Suggest Stacks
 - Start Date: 2019-04-25
+- Status: Implemented
 - CNB Pull Request: [rfcs#4](https://github.com/buildpacks/rfcs/pull/4), [pack#190](https://github.com/buildpacks/pack/pull/190)
 - CNB Issue: [pack#156](https://github.com/buildpacks/pack/issues/156)
 - Supersedes: N/A

diff --git a/text/0002-pack-logging-refactor.md b/text/0002-pack-logging-refactor.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Pack Logging Interface
 - Start Date: 2019-05-06
+- Status: Implemented
 - CNB Pull Request: [rfcs#6](https://github.com/buildpacks/rfcs/pull/6), [pack#182](https://github.com/buildpacks/pack/pull/182)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0003-pack-inspect-image.md b/text/0003-pack-inspect-image.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Inspect Image
 - Start Date: 2019-04-25
+- Status: Implemented
 - CNB Pull Request: [rfcs#5](https://github.com/buildpacks/rfcs/pull/5)
 - CNB Issue:
 - Supersedes: N/A

diff --git a/text/0004-rfc-process.md b/text/0004-rfc-process.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: RFC Process
 - Start Date: 2019-04-09
+- Status: Superseded
 - CNB Pull Request: [rfcs#1](https://github.com/buildpacks/rfcs/pull/1), [rfcs#7](https://github.com/buildpacks/rfcs/pull/7)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0005-contractual-build-plan.md b/text/0005-contractual-build-plan.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Contractual Build Plan
 - Start Date: 2019-04-12
+- Status: Implemented
 - CNB Pull Requests: [rfcs#12](https://github.com/buildpacks/rfcs/pull/12), [spec#52](https://github.com/buildpacks/spec/pull/52), [lifecycle#149](https://github.com/buildpacks/lifecycle/pull/149)
 - CNB Issues: (lifecycle issues to follow)
 

diff --git a/text/0006-stage-specific-mixins.md b/text/0006-stage-specific-mixins.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Stage-specific Mixins
 - Start Date: 2019-06-13
+- Status: Superseded
 - CNB Pull Requests: [rfcs#13](https://github.com/buildpacks/rfcs/pull/13), [spec#54](https://github.com/buildpacks/spec/pull/54)
 - CNB Issues: (lifecycle issues to follow)
 

diff --git a/text/0007-spec-distribution.md b/text/0007-spec-distribution.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Buildpack Distribution Specification
 - Start Date: 2019-04-12
+- Status: Implemented
 - CNB Pull Requests: [rfcs#11](https://github.com/buildpacks/rfcs/pull/11), [spec#53](https://github.com/buildpacks/spec/pull/53), [lifecycle#149](https://github.com/buildpacks/lifecycle/pull/149), [pack#243](https://github.com/buildpacks/pack/issues/243)
 - CNB Issues: (lifecycle issues to follow)
 

diff --git a/text/0008-buildpack-config-for-dist.md b/text/0008-buildpack-config-for-dist.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Buildpack Configuration for Distribution
 - Start Date: July 22, 2019
+- Status: Implemented
 - CNB Pull Request: [rfcs#15](https://github.com/buildpacks/rfcs/pull/15)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0009-auto-load-user-provided-environment-variables.md b/text/0009-auto-load-user-provided-environment-variables.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Auto-load User-provided Environment Variables
 - Start Date: 2019-06-17
+- Status: Implemented
 - CNB Pull Requests: [rfcs#14](https://github.com/buildpacks/rfcs/pull/14), [spec#55](https://github.com/buildpacks/spec/pull/55), [lifecycle#163](https://github.com/buildpacks/lifecycle/pull/163)
 - CNB Issues: (lifecycle issues to follow)
 

diff --git a/text/0010-api-versions.md b/text/0010-api-versions.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: API Versions
 - Start Date: 2019-08-05
+- Status: Implemented
 - CNB Pull Request: [rfcs#19](https://github.com/buildpacks/rfcs/pull/19), [pack#282](https://github.com/buildpacks/pack/pull/282)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0011-lifecycle-descriptor.md b/text/0011-lifecycle-descriptor.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Lifecycle Descriptor
 - Start Date: 08/05/2019
+- Status: Superseded
 - CNB Pull Request: [rfcs#20](https://github.com/buildpacks/rfcs/pull/20), [lifecycle#167](https://github.com/buildpacks/lifecycle/pull/167), [pack#269](https://github.com/buildpacks/pack/pull/269), [pack#294](https://github.com/buildpacks/pack/pull/294)
 - CNB Issue: [pack#293](https://github.com/buildpacks/pack/issues/293)
 - Supersedes: N/A

diff --git a/text/0012-service-binding.md b/text/0012-service-binding.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Service Binding
 - Start Date: 2019-08-06
+- Status: Superseded
 - CNB Pull Request: [rfcs#22](https://github.com/buildpacks/rfcs/pull/22), [spec#57](https://github.com/buildpacks/spec/pull/57)
 - CNB Issue:
 - Supersedes: N/A

diff --git a/text/0013-app-layer-metadata-source.md b/text/0013-app-layer-metadata-source.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Manifest - App metadata - add source type, version and metadata
 - Start Date: 2019-06-10
+- Status: Implemented
 - CNB Pull Request: [rfcs#9](https://github.com/buildpacks/rfcs/pull/9)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0014-combined-restorer-analyzer-phases.md b/text/0014-combined-restorer-analyzer-phases.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Lifecycle cache contract changes.
 - Start Date: 2019-08-02
+- Status: Implemented
 - CNB Pull Request: (leave blank)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0015-windows-lifecycle.md b/text/0015-windows-lifecycle.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Support for Windows in the Lifecycle components
 - Start Date: 2019-10-07
+- Status: Implemented
 - CNB Pull Request: [rfcs#27](https://github.com/buildpacks/rfcs/pull/27)
 - CNB Issue:
 - Supersedes: N/A

diff --git a/text/0016-use-email-more.md b/text/0016-use-email-more.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Use Email More
 - Start Date: 2019-12-05
+- Status: Implemented
 - CNB Pull Request: (leave blank)
 - CNB Issue: (leave blank)
 - Supersedes: (put "N/A" unless this replaces an existing RFC, then link to that RFC)

diff --git a/text/0017-pack-build-default-process-flag.md b/text/0017-pack-build-default-process-flag.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Pack Build Default Process Flag
 - Start Date: 2019-10-29
+- Status: Implemented
 - CNB Pull Request: [rfcs#28](https://github.com/buildpack/rfcs/pull/28)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0018-remove-pack-run.md b/text/0018-remove-pack-run.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Remove `pack run`
 - Start Date: 2019-12-11
+- Status: Implemented
 - CNB Pull Request: (leave blank)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0019-project-descriptor.md b/text/0019-project-descriptor.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Minimal Project Descriptor
 - Start Date: 2019-06-11
+- Status: Implemented
 - CNB Pull Request: (leave blank)
 - CNB Issue: (leave blank)
 - Supersedes: https://github.com/buildpack/rfcs/pull/25

diff --git a/text/0020-landing-page.md b/text/0020-landing-page.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Create a community landing page
 - Start Date: 1-6-2020
+- Status: Implemented
 - CNB Pull Request: [rfcs#42](https://github.com/buildpack/rfcs/pull/42)
 - CNB Issue: 42
 - Supersedes: (put "N/A" unless this replaces an existing RFC, then link to that RFC)

diff --git a/text/0021-lifecycle-compat-verification.md b/text/0021-lifecycle-compat-verification.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Lifecycle Compatibility Verification
 - Start Date: 2019-12-06
+- Status: Implemented
 - CNB Pull Request: [rfcs#34](https://github.com/buildpacks/rfcs/pull/34)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0022-client-side-buildpack-registry.md b/text/0022-client-side-buildpack-registry.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Client-Side Buildpack Registry
 - Start Date: 2019-11-21
+- Status: Superseded
 - CNB Pull Request: [rfcs#35](https://github.com/buildpacks/rfcs/pull/35)
 - CNB Issue: (leave blank)
 - Supersedes: https://github.com/buildpack/rfcs/pull/24

diff --git a/text/0023-circleci-orb.md b/text/0023-circleci-orb.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Support a CircleCI Orb
 - Start Date: 2019-12-15
+- Status: Implemented
 - CNB Pull Request: [rfcs#39](https://github.com/buildpacks/rfcs/pull/39)
 - CNB Issue: (leave blank)
 - Supersedes: N/A

diff --git a/text/0024-lifecycle-multicall-binary-for-build.md b/text/0024-lifecycle-multicall-binary-for-build.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Lifecycle as a multicall binary for build phases
 - Start Date: 01/21/2020
+- Status: Implemented
 - CNB Pull Request: [rfcs#45](https://github.com/buildpacks/rfcs/pull/45)
 - CNB Issue: (leave blank)
 - Supersedes: "N/A"

diff --git a/text/0025-dont-trust-builders.md b/text/0025-dont-trust-builders.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Isolate Registry Credentials from Builder Images
 - Start Date: 2020-01-14
+- Status: Implemented
 - CNB Pull Request: [rfcs#43](https://github.com/buildpacks/rfcs/pull/43)
 - CNB Issue:
 - Supersedes: N/A

diff --git a/text/0026-lifecycle-all.md b/text/0026-lifecycle-all.md
@@ -2,6 +2,7 @@
 [meta]: #meta
 - Name: Lifecycle All Binary
 - Start Date: 2020-01-21
+- Status: Implemented
 - CNB Pull Request: [rfcs#46](https://github.com/buildpacks/rfcs/pull/46)
 - CNB Issue: (leave blank)
 - Supersedes: N/A
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,3 +8,4 @@ filterLabels: @@
     assignees:
     - ekcasey
     - hone
+    - samj1912