Buildpack User Documentation

Building the Buildpack

To build this buildpack, run the following command 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.

1. Install buildpack-packager

./scripts/install_tools.sh

1. Build the buildpack

buildpack-packager build

1. 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.

To test this buildpack, run the following command 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.

1. Run unit tests

./scripts/unit.sh

1. Run integration tests

./scripts/integration.sh

More information can be found on Github cutlass.

Short turn around development

docker run -v $PWD:/bpdir:ro -it cloudfoundry/cflinuxfs2 su vcap

export CF_STACK=cflinuxfs2 
supply() {
  rm -rf /home/vcap/app /tmp/deps 
  cp -r /bpdir/fixtures/$1 /home/vcap/app
  mkdir -p /tmp/deps/0 /tmp/cache
  /bpdir/bin/supply /app /tmp/cache /tmp/deps 0
}
finalize() {
  /bpdir/bin/finalize /app /tmp/cache /tmp/deps 0
}

Reporting Issues

Open an issue on this project

Disclaimer

This buildpack is experimental and not yet intended for production use.