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
+25-10Lines changed: 25 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,11 +29,11 @@ Owners of the repository will watch out for and review new PRs.
29
29
30
30
If comments have been given in a review, they have to be addressed before merging.
31
31
32
-
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.
32
+
After addressing review comments, don't forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.
33
33
34
34
## CI
35
35
36
-
####GitHub actions
36
+
### GitHub actions
37
37
38
38
-[Next Dockerimage](https://github.com/devfile/devworkspace-operator/blob/main/.github/workflows/dockerimage-next.yml) action builds main branch and pushes it to [quay.io/devfile/devworkspace-controller:next](https://quay.io/repository/devfile/devworkspace-controller?tag=latest&tab=tags)
39
39
-[Code Coverage Report](./.github/workflows/code-coverage.yml) action creates a code coverage report using [codecov.io](https://about.codecov.io/).
@@ -50,7 +50,7 @@ To build, test and debug the DevWorkspace Operator the following development too
50
50
- git
51
51
- sed
52
52
- jq
53
-
- yq (python-yq from https://github.com/kislyuk/yq#installation, other distributions may not work)
53
+
- yq (python-yq from <https://github.com/kislyuk/yq#installation>, other distributions may not work)
54
54
- skopeo (if building the OLM catalogsource)
55
55
- podman or docker
56
56
@@ -62,20 +62,19 @@ system.
62
62
63
63
On macOS, the default `make` utility might be outdated, leading to issues with some `Makefile` targets. To resolve this, it's recommended to install a newer version of `make` using Homebrew and ensure it's prioritized in your system's `$PATH`.
64
64
65
-
1.**Install Homebrew `make`**:
65
+
1. Install Homebrew `make`:
66
66
67
67
```bash
68
68
brew install make
69
69
```
70
70
71
-
2. **Update your `$PATH`**:
72
-
Add the Homebrew `make` executable to your `$PATH` by adding the following line to your shell configuration file (e.g., `~/.zshrc`, `~/.bash_profile`):
71
+
2. Add the Homebrew `make` executable to your `$PATH` by adding the following line to your shell configuration file (e.g., `~/.zshrc`, `~/.bash_profile`):
6. Finally deploys the CRDs and the controller to the current cluster:
135
-
```
142
+
143
+
```bash
136
144
make install # <== this command copies the CRDs definition
137
145
# creates the namespace for the controller in the cluster
138
146
# downloads and runs kustomize to build the manifests
@@ -159,7 +167,8 @@ make run
159
167
```
160
168
161
169
> Note: The operator requires internet access from containers to work. By default, `crc setup` may not provision this, so it's necessary to configure DNS for Docker:
162
-
>```
170
+
>
171
+
>```text
163
172
># /etc/docker/daemon.json
164
173
> {
165
174
> "dns": ["192.168.0.1"]
@@ -210,26 +219,32 @@ make disconnect-debug-webhook-server
210
219
make update_devworkspace_api update_devworkspace_crds # first commit
211
220
make generate_all # second commit
212
221
```
222
+
213
223
Example of the devfile API update [PR](https://github.com/devfile/devworkspace-operator/pull/797)
214
224
215
225
### Remove controller from your K8s/OS Cluster
226
+
216
227
To uninstall the controller and associated CRDs, use the Makefile uninstall rule:
228
+
217
229
```bash
218
230
make uninstall
219
231
```
232
+
220
233
This will delete all custom resource definitions created for the controller, as well as the `devworkspace-controller` namespace.
221
234
222
235
### Build a custom OLM bundle
223
236
224
237
In order to build a custom bundle, the following environment variables should be set:
238
+
225
239
| variable | purpose | default value |
226
240
|---|---|---|
227
241
|`DWO_BUNDLE_IMG`| Image used for Operator bundle image |`quay.io/devfile/devworkspace-operator-bundle:next`|
228
242
|`DWO_INDEX_IMG`| Image used for Operator index image |`quay.io/devfile/devworkspace-operator-index:next`|
229
243
|`DEFAULT_DWO_IMG`| Image used for controller when generating defaults |`quay.io/devfile/devworkspace-controller:next`|
230
244
231
245
To build the index image and register its catalogsource to the cluster, run
232
-
```
246
+
247
+
```bash
233
248
make generate_olm_bundle_yaml build_bundle_and_index register_catalogsource
0 commit comments