Update buildpack metadata in buildpack.toml #692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adjusts the buildpack `name`, `description` and `keywords` in the `buildpack.toml` of all buildpacks to match the style discussed in: heroku/cnb-builder-images#408 These fields are used by the CNB registry and can also be seen in the output of `pack builder inspect`. They are not used by `pack build` or Kodon. In addition to standardising the metadata, one of the objectives here is to ensure users don't accidentally use component buildpacks when they really wanted the composite buildpack. The `keywords` field has intentionally been omitted from the functions buildpacks since they are EOL and so don't want to be made more discoverable. (The CNB registry doesn't currently ingest/display the keywords currently, but may in the future.) Lastly, I've cleaned up the `[metadata]` table/subtables to match the concise style used by the Procfile and Python CNBs. GUS-W-14121598.
edmorley
force-pushed
the
edmorley/update-buildpack-toml
branch
from
8d3dc97
to
05fd3d7
Compare
colincasey
approved these changes
Oct 23, 2023
There was a problem hiding this comment.
👍 Thanks @edmorley. Only noticed one minor detail with a changelog file missing an ending new line.
Merged
heroku-linguist bot
added a commit
that referenced
this pull request
Oct 24, 2023
* Prepare release v2.0.0 ## heroku/nodejs ### Added - Added `heroku/nodejs-npm-engine` to the buildpack group for npm support ([#623](#623)) - Added `heroku/nodejs-npm-install` to the buildpack group for npm support ([#625](#625)) - Added `heroku/nodejs-corepack` to the buildpack group for npm support ([#685](#685)) ### Changed - Updated buildpack display name, description and keywords. ([#692](#692)) - Updated `heroku/nodejs-corepack` to `2.0.0`. - Updated `heroku/nodejs-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-install` to `2.0.0`. - Updated `heroku/nodejs-pnpm-install` to `2.0.0`. - Updated `heroku/nodejs-yarn` to `2.0.0`. ### Removed - Removed the deprecated `heroku/nodejs-npm` from the buildpack group for npm support ([#625](#625)) - Removed `heroku/procfile`, since it's being added directly to the Heroku builder images instead. If you override the Heroku builder images' default buildpack detection order (or use this buildpack with a non-Heroku builder image), you will need to append `heroku/procfile` to your buildpacks list. ([#696](#696)) ## heroku/nodejs-corepack ### Added - Added support for using corepack to install npm. ([#685](#685)) ### Changed - Updated buildpack description and keywords. ([#692](#692)) - Switched from supporting explicitly named stacks to supporting the wildcard stack. ([#693](#693)) ## heroku/nodejs-engine ### Added - Added Node.js version 21.0.0. ### Changed - Updated buildpack description and keywords. ([#692](#692)) ### Removed - Dropped support for the end of life `io.buildpacks.stacks.bionic` stack. ([#693](#693)) ## heroku/nodejs-function ### Added - Added `heroku/nodejs-npm-engine` ([#686](#686)) - Added `heroku/nodejs-npm-install` ([#686](#686)) ### Removed - Removed `heroku/nodejs-npm` ([#686](#686)) ### Changed - Updated buildpack display name and description. ([#692](#692)) - Updated `heroku/nodejs-engine` to `2.0.0`. - Updated `heroku/nodejs-function-invoker` to `2.0.0`. - Updated `heroku/nodejs-npm-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-install` to `2.0.0`. ## heroku/nodejs-function-invoker ### Changed - Updated buildpack display name, description and keywords. ([#692](#692)) ## heroku/nodejs-npm ### Changed - Updated buildpack display name, description and keywords. ([#692](#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](#693)) ## heroku/nodejs-npm-engine ### Added - Initial release ## heroku/nodejs-npm-install ### Added - Initial release ## heroku/nodejs-pnpm-install ### Changed - Updated buildpack description and keywords. ([#692](#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](#693)) ## heroku/nodejs-yarn ### Changed - Updated buildpack description and keywords. ([#692](#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](#693)) * Replace non-breaking spaces with normal spaces Yey copy-paste from GitHub PR diffs. --------- Co-authored-by: heroku-linguist[bot] <136119646+heroku-linguist[bot]@users.noreply.github.com> Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com>
heroku-linguist bot
added a commit
to heroku/cnb-builder-images
that referenced
this pull request
Oct 25, 2023
* Update heroku/buildpacks-nodejs to v2.0.0 ## heroku/nodejs ### Added - Added `heroku/nodejs-npm-engine` to the buildpack group for npm support ([#623](heroku/buildpacks-nodejs#623)) - Added `heroku/nodejs-npm-install` to the buildpack group for npm support ([#625](heroku/buildpacks-nodejs#625)) - Added `heroku/nodejs-corepack` to the buildpack group for npm support ([#685](heroku/buildpacks-nodejs#685)) ### Changed - Updated buildpack display name, description and keywords. ([#692](heroku/buildpacks-nodejs#692)) - Updated `heroku/nodejs-corepack` to `2.0.0`. - Updated `heroku/nodejs-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-install` to `2.0.0`. - Updated `heroku/nodejs-pnpm-install` to `2.0.0`. - Updated `heroku/nodejs-yarn` to `2.0.0`. ### Removed - Removed the deprecated `heroku/nodejs-npm` from the buildpack group for npm support ([#625](heroku/buildpacks-nodejs#625)) - Removed `heroku/procfile`, since it's being added directly to the Heroku builder images instead. If you override the Heroku builder images' default buildpack detection order (or use this buildpack with a non-Heroku builder image), you will need to append `heroku/procfile` to your buildpacks list. ([#696](heroku/buildpacks-nodejs#696)) ## heroku/nodejs-corepack ### Added - Added support for using corepack to install npm. ([#685](heroku/buildpacks-nodejs#685)) ### Changed - Updated buildpack description and keywords. ([#692](heroku/buildpacks-nodejs#692)) - Switched from supporting explicitly named stacks to supporting the wildcard stack. ([#693](heroku/buildpacks-nodejs#693)) ## heroku/nodejs-engine ### Added - Added Node.js version 21.0.0. ### Changed - Updated buildpack description and keywords. ([#692](heroku/buildpacks-nodejs#692)) ### Removed - Dropped support for the end of life `io.buildpacks.stacks.bionic` stack. ([#693](heroku/buildpacks-nodejs#693)) ## heroku/nodejs-function ### Added - Added `heroku/nodejs-npm-engine` ([#686](heroku/buildpacks-nodejs#686)) - Added `heroku/nodejs-npm-install` ([#686](heroku/buildpacks-nodejs#686)) ### Removed - Removed `heroku/nodejs-npm` ([#686](heroku/buildpacks-nodejs#686)) ### Changed - Updated buildpack display name and description. ([#692](heroku/buildpacks-nodejs#692)) - Updated `heroku/nodejs-engine` to `2.0.0`. - Updated `heroku/nodejs-function-invoker` to `2.0.0`. - Updated `heroku/nodejs-npm-engine` to `2.0.0`. - Updated `heroku/nodejs-npm-install` to `2.0.0`. ## heroku/nodejs-function-invoker ### Changed - Updated buildpack display name, description and keywords. ([#692](heroku/buildpacks-nodejs#692)) ## heroku/nodejs-npm ### Changed - Updated buildpack display name, description and keywords. ([#692](heroku/buildpacks-nodejs#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](heroku/buildpacks-nodejs#693)) ## heroku/nodejs-npm-engine ### Added - Initial release ## heroku/nodejs-npm-install ### Added - Initial release ## heroku/nodejs-pnpm-install ### Changed - Updated buildpack description and keywords. ([#692](heroku/buildpacks-nodejs#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](heroku/buildpacks-nodejs#693)) ## heroku/nodejs-yarn ### Changed - Updated buildpack description and keywords. ([#692](heroku/buildpacks-nodejs#692)) ### Removed - Removed redundant explicitly named supported stacks. ([#693](heroku/buildpacks-nodejs#693)) * Add `heroku/procfile` to the `heroku/nodejs` order groups Since the Procfile CNB is no longer included in the `heroku/nodejs` as of: heroku/buildpacks-nodejs#696 --------- Co-authored-by: heroku-linguist[bot] <136119646+heroku-linguist[bot]@users.noreply.github.com> Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adjusts the buildpack
name,descriptionandkeywordsin thebuildpack.tomlof all buildpacks to match the style discussed in:heroku/cnb-builder-images#408
These fields are used by the CNB registry and can also be seen in the output of
pack builder inspect. They are not used bypack buildor Kodon. In addition to standardising the metadata, one of the objectives here is to ensure users don't accidentally use component buildpacks when they really wanted the composite buildpack.The
keywordsfield has intentionally been omitted from the functions buildpacks since they are EOL and so don't want to be made more discoverable. (The CNB registry doesn't currently ingest/display the keywords currently, but may in the future.)In addition, I've marked the older Bash based npm buildpack as deprecated, to try and ensure users don't pick that over the newer buildpacks when browsing the CNB registry (we'll need to publish it one more time before it's deleted from this repo).
Lastly, I've cleaned up the
[metadata]table/subtables to match the concise style used by the Procfile and Python CNBs.GUS-W-14121598.