ruby-buildpack

README

Cloud Foundry Ruby Buildpack

Join us on Slack

A Cloud Foundry buildpack for Ruby based apps.

Buildpack User Documentation

Official buildpack documentation can be found at Ruby buildpack docs.

Building the Buildpack

To build this buildpack, run the following commands from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   source .envrc
   

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Install buildpack-packager

   go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager@master
   

3. Build the buildpack

   buildpack-packager build [ --cached ]
   

4. Use in Cloud Foundry

   Upload the buildpack to your Cloud Foundry and optionally specify it by name

   cf create-buildpack [BUILDPACK_NAME] [BUILDPACK_ZIP_FILE_PATH] 1
   cf push my_app [-b BUILDPACK_NAME]
   

Testing

Buildpacks use the Cutlass framework for running integration tests against Cloud Foundry. Before running the integration tests, you need to login to your Cloud Foundry using the cf cli:

cf login -a https://api.your-cf.com -u name@example.com -p pa55woRD

Note that your user requires permissions to run cf create-buildpack and cf update-buildpack. To run the integration tests, run the following commands from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   source .envrc
   

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Run unit tests

   ./scripts/unit.sh
   

3. Run integration tests

   ./scripts/integration.sh
   

More information can be found on Github cutlass.

Contributing

Find our guidelines here.

Help and Support

Join the #buildpacks channel in our Slack community if you need any further assistance.

Reporting Issues

Please fill out the issue template fully if you'd like to start an issue for the buildpack.

Active Development

The project backlog is on Pivotal Tracker.

Acknowledgements

Inspired by the Heroku buildpack.