Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.7 KB

development.md

File metadata and controls

76 lines (48 loc) · 1.7 KB
Raw

Development

Build

Prerequisites

Before building from source, be sure to install:

On macOS systems with Homebrew, run: brew install go@1.19 protobuf

Install from source

  1. Verify that you have Go 1.19+ installed:

    $ go version

If go is not installed or an older version exists, follow instructions on the Go website.

  1. Clone this repository:

    $ git clone https://github.com/mondoohq/cnspec.git
$ cd cnspec

  2. Build and install:

    Unix-like systems

    # To install cnspec using Go into the $GOBIN directory:
make cnspec/install

Develop cnspec

Whenever you change protos or other auto-generated files, you must regenerate files for the compiler. To do this, be sure you have the necessary tools installed (such as protobuf):

make prep

You also need to have the required dependencies present:

make prep/repos

When the repo is already present and something changed upstream, update the dependencies:

make prep/repos/update

Then, whenever you make changes, just run:

make cnspec/generate

This generates and updates all required files for the build. At this point you can make cnspec/install again as outlined above.

Contribute changes

Mark PRs with emojis

We love emojis in our commits. These are their meanings:

🛑 breaking 🐛 bugfix 🧹 cleanup/internals ⚡ speed 📄 docs
✨⭐🌟🌠 smaller or larger features 🐎 race condition
🌙 MQL 🌈 visual 🟢 fix tests 🎫 auth 🦅 falcon 🐳 container