https://github.com/paketo-buildpacks/procfile

A buildpack for translating a Procfile into Process Types
https://github.com/paketo-buildpacks/procfile

all-applications cnb procfile utilities

Last synced: about 2 months ago
JSON representation

A buildpack for translating a Procfile into Process Types

• Host: GitHub
• URL: https://github.com/paketo-buildpacks/procfile
• Owner: paketo-buildpacks
• License: apache-2.0
• Created: 2020-03-04T17:28:13.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T13:19:54.000Z (about 2 months ago)
• Last Synced: 2024-07-29T16:56:55.756Z (about 2 months ago)
• Topics: all-applications, cnb, procfile, utilities
• Language: Go
• Homepage:
• Size: 398 KB
• Stars: 14
• Watchers: 7
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-cnb - Procfile Paketo Buildpack

README

        
# `gcr.io/paketo-buildpacks/procfile`

The Procfile Buildpack is a Cloud Native Buildpack that turns the contents of a Procfile into process types.

## Behavior

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

The buildpack will do the following:

* When `BP_PROCFILE_DEFAULT_PROCESS` is set, it will contribute the `web` process type to the image.

* Contribute the process types from one or both `Procfile` files to the image.

  * If process types are identified from both Binding _and_ file, the contents are merged into a single `Procfile`. Commands from the Binding take precedence if there are duplicate types.

  * If process types are identified from environment _and_ Binding _or_ file, the contents are merged into a single `Procfile`. Commands from Binding or file take precedence if there are duplicate types, with Binding taking precedence over file.

  * If the application's stack is `io.paketo.stacks.tiny` the contents of the `Procfile` must be single command with zero or more space delimited arguments. Argument values containing whitespace should be quoted. The resulting process will be executed directly and will not be parsed by the shell.

  * If the application's stack is not `io.paketo.stacks.tiny` the contents of `Procfile` will be executed as a shell script.

## Bindings

The buildpack optionally accepts the following bindings:

|Key                   | Value   | Description

|----------------------|---------|------------

|`Procfile` |List of`: ` entries | The entries from this Binding will be merged with those from the application's `Procfile`, if both are present. The commands from this Binding take precedence over the application's `Procfile` if there are duplicate process-types.

## License

This buildpack is released under version 2.0 of the [Apache License][a].

[a]: http://www.apache.org/licenses/LICENSE-2.0