Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.67 KB
Raw

Contributing to bosh-openstack-cpi-release

Contributor License Agreement

Follow these steps to make a contribution to any of CF open source repositories:

  1. Ensure that you have completed our CLA Agreement for individuals or corporations.

  2. Set your name and email (these should match the information on your submitted CLA)

     git config --global user.name "Firstname Lastname"
 git config --global user.email "[email protected]"

  3. If your company has signed a Corporate CLA, but sure to make the membership in your company's github organization public

Development

Prerequisites:

  • ruby 2.x
  • bundler

Running unit tests

The CPI Ruby code has unit tests that can be run as follows.

./scripts/test-unit

Running ERB job templates unit tests

The ERB templates rendered by the jobs of this Bosh Release have specific unit tests that are run along with the other unit tests as instructed above. When required, you can run them separately though, with this command:

./scripts/test-unit-erb

Running manual tests

Note: This is not required for opening a pull request. Having green unit tests is good enough from our perspective.

If you still want to run manual tests (e.g. in order to validate your use case) this is how you do it:

  • Create a dev release and deploy a BOSH director using it.

  • Create the BOSH release:

    $ bosh create release --force --with-tarball

  • Deploy a BOSH Director using your CPI release (see bosh.io)