Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add terminology section to the buildpack spec #300

Merged
merged 7 commits into from
Aug 23, 2022

Conversation

natalieparellano
Copy link
Member

Resolves #145

Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
@ekcasey ekcasey linked an issue Mar 30, 2022 that may be closed by this pull request
@ekcasey
Copy link
Member

ekcasey commented Mar 30, 2022

Moving to buildpack/0.9 - a branch needs to be created

buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
Signed-off-by: Natalie Arellano <narellano@vmware.com>
buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
@@ -91,6 +80,54 @@ Buildpack API versions:
- `<major>` and `<minor>` MUST only contain numbers (unsigned 64 bit integer)
- When `<major>` is greater than `0` increments to `<minor>` SHALL exclusively indicate additive changes

## Terminology

### CNB Terminology
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback from 4/21 Working Group: (if possible, without making each term its own section) we should link back to this section as much as is practical.

buildpack.md Outdated Show resolved Hide resolved
buildpack.md Outdated Show resolved Hide resolved
@natalieparellano natalieparellano self-assigned this Jun 16, 2022
@natalieparellano natalieparellano changed the base branch from buildpack/0.8 to buildpack/0.9 June 16, 2022 18:22
Signed-off-by: Natalie Arellano <narellano@vmware.com>

A buildpack descriptor that specifies `stacks` MUST describe a buildpack that implements the [Buildpack Interface](#buildpack-interface).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really know what the latter half of this sentence is for

@@ -1097,9 +1130,7 @@ Each stack in `stacks` either:
- `id` MUST be set to the special value `"*"`.
- `mixins` MUST be empty.

#### Order Buildpacks

A buildpack descriptor that specifies `order` MUST be [resolvable](#order-resolution) into an ordering of buildpacks that implement the [Buildpack Interface](#buildpack-interface).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to terminology

Signed-off-by: Natalie Arellano <narellano@vmware.com>

The resolution process MUST follow this pattern:

Where:
- O and P are buildpack orders.
- A through H are buildpack implementations.
- A through H are component buildpacks.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is correct. But I'm a bit less sure of myself here.

@natalieparellano
Copy link
Member Author

@buildpacks/buildpack-authors-tooling-maintainers @buildpacks/implementation-maintainers I think this is ready for another review

Copy link
Member

@samj1912 samj1912 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - I still feel a bit queasy about "component" buildpack as a term but I can't think of a good alternative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add terminology section to Buildpack API
6 participants