github.com/dmvolod/operator-sdk@v0.8.2/doc/dev/developer_guide.md (about)

     1  # Developer guide
     2  
     3  This document explains how to setup your dev environment.
     4  
     5  ## Prerequisites
     6  - [dep][dep_tool] version v0.5.0+
     7  - [git][git_tool]
     8  - [go][go_tool] version v1.12+
     9  
    10  ## Download Operator SDK
    11  
    12  Go to the [Operator SDK repo][repo_sdk] and follow the [fork guide][fork_guide] to fork, clone, and setup the local operator-sdk repository.
    13  
    14  ## Vendor dependencies
    15  
    16  Run the following in the project root directory to update the vendored dependencies:
    17  
    18  ```sh
    19  $ cd $GOPATH/src/github.com/operator-framework/operator-sdk
    20  $ make dep
    21  ```
    22  
    23  ## Build the Operator SDK CLI
    24  
    25  Build the Operator SDK CLI `operator-sdk` binary:
    26  
    27  ```sh
    28  $ make install
    29  ```
    30  
    31  ## Testing
    32  
    33  The SDK includes many tests that are run as part of CI.
    34  To build the binary and run all tests (assuming you have a correctly configured environment),
    35  you can simple run:
    36  
    37  ```sh
    38  $ make test-ci
    39  ```
    40  
    41  If you simply want to run the unit tests, you can run:
    42  
    43  ```sh
    44  $ make test
    45  ```
    46  
    47  For more information on running testing and correctly configuring your environment,
    48  refer to the [`Running the Tests Locally`][running-the-tests] document.
    49  
    50  See the project [README][sdk_readme] for more details.
    51  
    52  [dep_tool]:https://golang.github.io/dep/docs/installation.html
    53  [git_tool]:https://git-scm.com/downloads
    54  [go_tool]:https://golang.org/dl/
    55  [repo_sdk]:https://github.com/operator-framework/operator-sdk
    56  [fork_guide]:https://help.github.com/en/articles/fork-a-repo
    57  [docker_tool]:https://docs.docker.com/install/
    58  [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
    59  [sdk_readme]:../../README.md
    60  [running-the-tests]: ./testing/running-the-tests.md