github.com/codeready-toolchain/api@v0.0.0-20240507023248-73662d6db2c5/README.adoc (about)

     1  = ToolChain API
     2  
     3  image:https://goreportcard.com/badge/github.com/codeready-toolchain/api[Go Report Card, link="https://goreportcard.com/report/github.com/codeready-toolchain/api"]
     4  image:https://codecov.io/gh/codeready-toolchain/api/branch/master/graph/badge.svg[Codecov.io,link="https://codecov.io/gh/codeready-toolchain/api"]
     5  
     6  == Building
     7  Requires:
     8  
     9  * Go version 1.18.x (1.18.8 or higher) - download for your development environment https://golang.org/dl/[here].
    10  * Operator SDK v1.23.0 - download for your development environment https://v1-23-x.sdk.operatorframework.io/docs/installation/#install-from-github-release[here]
    11  
    12  CodeReady ToolChain API is built using https://github.com/golang/go/wiki/Modules[Go modules].
    13  
    14  To re-generate the `zz_generated.deepcopy.go` and `zz_generated.openapi.go` files as well as the CRD files, run the following command:
    15  
    16  ```sh
    17  make generate
    18  ```
    19  
    20  NOTE: the `make generate` will generate the CRD files in the local `config/crd/bases` directory and then dispatch the `.yaml` files in the `host-operator` and `member-operator` repositories, assuming they have been checked out and that *they are in a clean state*, meaning that they have no pending changes, besides previous versions of the CRD files.
    21  
    22  NOTE: Then you are supposed to create PRs also in the repos where the change was propagated ( host | member-operator ). Please do not mix other changes to the code with those CRD changes. While it would work technically , it’s always preferred to promote the CRD changes separately for easier PR review.
    23