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

Document that binding needs also the type Procfile #251

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

c0d1ngm0nk3y
Copy link
Contributor

It is only documented that the binding needs to have the key Procfile, but in fact it also needs the type to be Procfile.

Summary

Use Cases

Checklist

  • I have viewed, signed, and submitted the Contributor License Agreement.
  • I have linked issue(s) that this PR should close using keywords or the Github UI (See docs)
  • I have added an integration test, if necessary.
  • I have reviewed the styleguide for guidance on my code quality.
  • I'm happy with the commit history on this PR (I have rebased/squashed as needed).

@c0d1ngm0nk3y c0d1ngm0nk3y requested a review from a team as a code owner October 25, 2024 11:05
@dmikusa
Copy link
Contributor

dmikusa commented Oct 25, 2024

This buildpack will participate if one or all of the following conditions are met:

The application contains a Procfile
A Binding exists with type Procfile and secret containing a Procfile
The BP_PROCFILE_DEFAULT_PROCESS environment variable is set to a non-empty value

We typically document the required type in the section that describes the condition for participation, since it's usually the type that is required there.

I'm not opposed to adding it to the table as well, but it will leave the tables inconsistent across buildpacks. My only ask would be that as you're submitting PRs for other buildpacks, if you remember, update the bindings table in the README for those as well. I'll try to remember to do the same.

@dmikusa dmikusa added type:documentation A documentation update semver:patch A change requiring a patch version bump labels Oct 25, 2024
@dmikusa dmikusa merged commit b2eb1bc into paketo-buildpacks:main Oct 25, 2024
7 checks passed
@c0d1ngm0nk3y c0d1ngm0nk3y deleted the fix-readme branch November 8, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver:patch A change requiring a patch version bump type:documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants