Code Monkey home page Code Monkey logo

sensu-go's Introduction

Sensu 2.0

Build Status

Contributing/Development

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.

Protobuf

Overview

We are using the version proto3 of the protocol buffers language. Here's some useful ressources:

To learn more about protocol buffers

The proto3 language guide

Installation

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.

Quick Start

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.

Dependencies

Sensu uses golang/dep for managing it's dependencies.

Usage

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

Further Reading

Testing

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

sensu-go's People

Contributors

amdprophet avatar dabria avatar echlebek avatar grepory avatar jamesdphillips avatar mercul3s avatar palourde avatar portertech avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.