api

module
v0.0.0-...-49462fd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 20, 2024 License: Apache-2.0

README

= ToolChain API

image:https://goreportcard.com/badge/github.com/codeready-toolchain/api[Go Report Card, link="https://goreportcard.com/report/github.com/codeready-toolchain/api"]
image:https://codecov.io/gh/codeready-toolchain/api/branch/master/graph/badge.svg[Codecov.io,link="https://codecov.io/gh/codeready-toolchain/api"]

== Building
Requires:

* Go version 1.18.x (1.18.8 or higher) - download for your development environment https://golang.org/dl/[here].
* Operator SDK v1.23.0 - download for your development environment https://v1-23-x.sdk.operatorframework.io/docs/installation/#install-from-github-release[here]

CodeReady ToolChain API is built using https://github.com/golang/go/wiki/Modules[Go modules].

To re-generate the `zz_generated.deepcopy.go` and `zz_generated.openapi.go` files as well as the CRD files, run the following command:

```sh
make generate
```

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.

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.

Directories

Path Synopsis
api
v1alpha1
Package v1alpha1 contains API Schema definitions for the toolchain.dev.openshift.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=toolchain.dev.openshift.com
Package v1alpha1 contains API Schema definitions for the toolchain.dev.openshift.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=toolchain.dev.openshift.com
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL