Home

Awesome

Heroku Cloud Native Buildpack: Procfile

Cloud Native Buildpacks Registry: heroku/procfile CI on Github Actions: heroku/procfile

heroku/procfile is the Heroku Cloud Native Buildpack for applications that use a Procfile to declare process types. It replicates the behavior of Procfile from builds on the Heroku Platform.

[!IMPORTANT] This is a Cloud Native Buildpack, and is a component of the Heroku Cloud Native Buildpacks project, which is in preview.

Usage

[!NOTE] Before getting started, ensure you have the pack CLI installed. Installation instructions are available here.

To build an application codebase with a Procfile into a production image:

$ cd ~/workdir/sample-procfile-app
$ pack build sample-app --builder heroku/builder:24

Then run the image:

docker run --rm -it -e "PORT=8080" -p 8080:8080 sample-app

Application Requirements

This buildpack requires a properly formatted Procfile to exist in the root project directory.

Configuration

You may configure which process types and commands are included in a build result like this:

# Example Procfile
web: bundle exec rails server -p $PORT
worker: bundle exec rake jobs:work

Contributing

Issues and pull requests are welcome. See our contributing guidelines if you would like to help.