Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.42 KB
Raw

Contributing

Requirements

  • docker
  • docker-compose
  • jet

Installing node_modules locally

If you want to have the node_modules folder locally on the host system (useful for IDEs that integrate with our eslint for example), you can run:

docker build -t kit-deploymentizer . && id=$(docker create kit-deploymentizer) && docker cp $id:/node_modules ./node_modules && docker rm $id

Running build and tests

You can use the Codeship jet command to build and run all tests in parallel.

  1. jet steps

Manually building

This is an example of building the image locally, and then running it locally using volumes and one of the existing examples in the test directory.

  1. docker build -t kit-deploymentizer .
  2. docker run --rm -v $(pwd)/generated:/generated -v $(pwd)/test/fixture:/manifests kit-deploymentizer --load /manifests

Breaking Changes

If you ever need to implement breaking changes (non-backwards-compatible changes) to this service, you should increment the major tag version accordingly. To do this, simply update the image_tag property for the major version registry step in codeship-steps.yml. Other services will have to be manually updated to point to the latest major version tag to receive the newest image, during which time any configuration adjustments needed can be made.