To make a good faith effort to ensure the criteria of the MIT License are met, Sensu Inc. requires the Developer Certificate of Origin (DCO) process to be followed.
For guidelines on how to contribute to this project and more information on the DCO, please see CONTRIBUTING.md.
We are using the version proto3 of the protocol buffers language. Here's some useful ressources:
To learn more about protocol buffers
Install the protobuf compiler since we don't use the one that golang uses.
brew install protobuf
Otherwise, see the for non-C++ users instructions here.
Once you make a change to any *.proto
file within the types package, you will need regenerate the associated *.pb.go
file. To do so, simply run the genproto.sh script, which will install all required dependencies and launch the code generation.
Sensu uses golang/dep for managing it's dependencies.
Running the following will install dep
(if it is not already) and pull all
required dependencies.
./build.sh deps
Later, if you would like to add a dependency, run:
dep ensure -add https://my-repo.com/my/dep
If you would like to update a dependency, run:
dep ensure -update https://my-repo.com/my/dep
When you would like to remove a dependency, remove the it from Gopkg.toml
and
then run:
dep prune
Install dependencies:
./build.sh deps
Run test suites:
./build.sh ci
Run end-to-end tests:
./build.sh e2e
# To run a specific test:
./build.sh e2e -run TestRBAC
# To prevent tests from running in parallel:
./build.sh e2e -parallel 1