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
@@ -22,10 +22,10 @@ In order to run all the commands mentioned below, you will need the following in
22
22
23
23
### 1. Add CRD to catalog
24
24
25
-
All CRDs of this project are managed in the [catalog](https://github.com/metio/kube-custom-resources-rs/blob/main/code-generator/src/catalog.rs) which contains a long list of projects along with the CRDs they are producing. We try to sort this list alphabetically in order to make it easier finding things, but this is not a hard requirement for your contribution. Each entry requires the following details:
25
+
All CRDs of this project are managed in the [catalog](https://github.com/metio/kube-custom-resources-rs/blob/main/code-generator/src/catalog.rs) which contains a long list of projects along with the CRDs they are producing. We try to sort this list alphabetically to make it easier finding things, but this is not a hard requirement for your contribution. Each entry requires the following details:
26
26
27
27
-`project_name`: The organization and name of a project, e.g. `prometheus-operator/prometheus-operator` is used for the project at https://github.com/prometheus-operator/prometheus-operator.
28
-
-`license`: The SPDX license identifier for the CRD files. This is usually the same license as the project and the catalog file already contains constants for the most common licenses.
28
+
-`license`: The SPDX license identifier for the CRD files. This is usually the same license as the project, and the catalog file already contains constants for the most common licenses.
29
29
-`urls`: The list of URLs where CRDs are located. It does not matter if that file contains other Kubernetes resources, our tooling will only extract CRDs from those files.
By default, we call kopium with the following arguments:
68
-
69
-
-`--docs`
70
-
-`--filename=...`
71
-
-`--derive=Default`
72
-
-`--derive=PartialEq`
73
-
74
-
Some CRDs cannot implement the `Default` trait. In those cases, add an `.args` file next to the downloaded `.yaml` file in the catalog and specify the **derive** directives to use (docs and filename will always be set), e.g.:
75
-
76
-
```
77
-
--derive=PartialEq
78
-
```
55
+
### 4. Adjust Output
79
56
80
57
Some CRDs cannot be converted to Rust code at all. In those cases, add an `.ignore` file next to the downloaded `.yaml` file in the catalog and write the reason why this CRD was ignored into the file, e.g.:
81
58
82
59
```
83
60
CRD has no spec field
84
61
```
85
62
86
-
### 6. Open Pull Request
63
+
### 5. Open Pull Request
87
64
88
65
Commit your changes, push them into your fork and open a pull request. Don't worry if certain steps did not work on your machine, we will sort them out during review. Thanks again for contributing :tada::+1:
0 commit comments