Development - mlafeldt/chef-runner GitHub Wiki

Build chef-runner from source

First, make sure you have a recent Go version installed.

This single line will download, compile, and install the chef-runner command-line tool:

$ go get github.com/mlafeldt/chef-runner

For this command to work, $GOPATH must be set correctly. Also check that $GOPATH is part of $PATH, so that the chef-runner executable can be found. For example, here are the relevant lines from my ~/.bashrc file:

export GOPATH="$HOME/devel/go"
export GOROOT="$(go env GOROOT)"
export PATH="$GOPATH/bin:$GOROOT/bin:$PATH"

Testing

chef-runner comes with lots of unit tests that help to ensure the tool works as expected. You can run all tests this way:

$ ./script/test

How to contribute

We welcome contributed improvements and bug fixes via the usual workflow:

  1. Fork this repository
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new pull request

When changing Go code, make sure to follow these guidelines.