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

Adds api to buildpack.toml schema #61

Merged
merged 2 commits into from
Sep 25, 2019
Merged

Adds api to buildpack.toml schema #61

merged 2 commits into from
Sep 25, 2019

Conversation

ekcasey
Copy link
Member

@ekcasey ekcasey commented Sep 18, 2019

Signed-off-by: Micah Young myoung@pivotal.io
Signed-off-by: Emily Casey ecasey@pivotal.io

Signed-off-by: Micah Young <myoung@pivotal.io>
Signed-off-by: Emily Casey <ecasey@pivotal.io>
buildpack.md Outdated Show resolved Hide resolved
Signed-off-by: Emily Casey <ecasey@pivotal.io>
- MUST describe the implemented buildpack API.
- SHALL indicate compatibility with a given lifecycle according to the following rules:
- When `<major>` is `0`, the buildpack is only compatible with lifecycles implementing that exact buildpack API.
- When `<major>` is greater than `0`, the buildpack is only compatible with lifecycles implementing buildpack API `<major>.<minor>`, where `<major>` of the lifecycle equals `<major>` of the buildpack and `<minor>` of the lifecycle is greater than or equal to `<minor>` of the buildpack.
Copy link
Member

Choose a reason for hiding this comment

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

Does this mean that if you specify api = 1 that it isn't compatible with 1.1 b/c api = 1 is equivalent to api = 1.0?

Copy link
Member Author

Choose a reason for hiding this comment

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

If the buildpack specifies api = 1 it IS compatible with lifecycle where buildpack = 1.1 b/c 1 (the minor of the lifecycle) is greater than or equal to 0 (the implied minor 0 of the buildpack)

Copy link
Member Author

Choose a reason for hiding this comment

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

happy to reword if it's confusing

Copy link
Member

Choose a reason for hiding this comment

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

I think that matches what's written. What about in the inverse case? api = 1.1 would not work on a lifecycle that sets buildpack = 1.0, right?

Copy link
Member

Choose a reason for hiding this comment

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

Just chatted with @ekcasey and she confirmed the above.

@ekcasey ekcasey merged commit fee76c2 into master Sep 25, 2019
@ekcasey ekcasey deleted the api-in-buildpack-toml branch September 25, 2019 21:53
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.

None yet

5 participants