You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -32,11 +32,13 @@ The repository structure MUST be compliant with `operator-sdk` scaffolding, whic
32
32
33
33
Refer to the [Operator SDK documentation](https://sdk.operatorframework.io/docs/building-operators/golang/) how to generate new APIs, Webhook and other parts of the project.
34
34
35
+
If you make any change to the api definitions, please run `make update-bundle` to update the bundle manifest accordingly.
36
+
35
37
### Local run
36
38
37
39
Build the manifests, install the CRD and run the operator as a local process:
38
40
```bash
39
-
make bundle install run
41
+
make install run
40
42
```
41
43
42
44
### Deployment with webhooks
@@ -66,7 +68,7 @@ When deploying the operator into the cluster using `make deploy`, an image in th
66
68
*`IMG`, to override the entire image specification
@# on make bundle config/manager/kustomization.yaml includes changes, which should be ignored for the below check
93
-
@git restore config/manager/kustomization.yaml
91
+
ensure-generate-is-noop: update-bundle
94
92
@git diff -s --exit-code apis/v1alpha1/zz_generated.*.go || (echo "Build failed: a model has been changed but the generated resources aren't up to date. Run 'make generate' and update your PR."&&exit 1)
95
-
@git diff -s --exit-code bundle config || (echo "Build failed: the bundle, config files has been changed but the generated bundle, config files aren't up to date. Run 'make bundle' and update your PR."&& git diff &&exit 1)
96
-
@git diff -s --exit-code bundle.Dockerfile || (echo "Build failed: the bundle.Dockerfile file has been changed. The file should be the same as generated one. Run 'make bundle' and update your PR."&& git diff &&exit 1)
93
+
@git diff -s --exit-code bundle config || (echo "Build failed: the bundle, config files has been changed but the generated bundle, config files aren't up to date. Run 'make update-bundle' and update your PR."&& git diff &&exit 1)
94
+
@git diff -s --exit-code bundle.Dockerfile || (echo "Build failed: the bundle.Dockerfile file has been changed. The file should be the same as generated one. Run 'make update-bundle' and update your PR."&& git diff &&exit 1)
97
95
@git diff -s --exit-code docs/api.md || (echo "Build failed: the api.md file has been changed but the generated api.md file isn't up to date. Run 'make api-docs' and update your PR."&& git diff &&exit 1)
0 commit comments