Skip to content

developer_guide.md

Latest commit

 

History

History
60 lines (42 loc) · 1.57 KB

developer_guide.md

File metadata and controls

60 lines (42 loc) · 1.57 KB

Developer guide

This document explains how to setup your dev environment.

Prerequisites

  • dep version v0.5.0+
  • git
  • go version v1.12+

Download Operator SDK

Go to the Operator SDK repo and follow the fork guide to fork, clone, and setup the local operator-sdk repository.

Vendor dependencies

Run the following in the project root directory to update the vendored dependencies:

$ cd $GOPATH/src/github.com/operator-framework/operator-sdk
$ make dep

Build the Operator SDK CLI

Build the Operator SDK CLI operator-sdk binary:

$ make install

Testing

The SDK includes many tests that are run as part of CI. To build the binary and run all tests (assuming you have a correctly configured environment), you can simple run:

$ make test-ci

If you simply want to run the unit tests, you can run:

$ make test

For more information on running testing and correctly configuring your environment, refer to the Running the Tests Locally document.

See the project README for more details.