Update docs with additional steps for adding new types #1133
Conversation
Signed-off-by: Dibyo Mukherjee <[email protected]>
googlebot
added
the
cla: yes
tekton-robot
added
the
size/S
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dibyom, vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
|
/retest |
|
/test pull-tekton-pipeline-build-tests |
| @@ -270,7 +270,13 @@ To look at the logs for individual `TaskRuns` or `PipelineRuns`, see | |||
| If you need to add a new CRD type, you will need to add: | |||
|
|
|||
| 1. A yaml definition in [config/](./config) | |||
| 1. Add the type to the cluster roles in | |||
| [200-clusterrole.yaml](./config/200-clusterrole.yaml) | |||
| 1. Add the type to the cluster roles in: | |||
There was a problem hiding this comment.
This is very helpful, thank you!
| - [200-clusterrole.yaml](./config/200-clusterrole.yaml) | ||
| - [clusterrole-aggregate-edit.yaml](./config/clusterrole-aggregate-edit.yaml) | ||
| - [clusterrole-aggregate-view.yaml](./config/clusterrole-aggregate-view.yaml) | ||
| 1. Add go structs for the types in [pkg/apis/pipelines/v1alpha1](./pkg/apis/pipeline/v1alpha1) |
There was a problem hiding this comment.
NIT: I'm not sure if we should include this, or only this. I guess the API types are the bare minimum, but perhaps we should include the [type]_validation and [type]_default modules as well; and perhaps the controller as well.
There was a problem hiding this comment.
hmmm, so in order to register with the webhook, the types have to be both Defaultable as well as Validatable. But probably worth calling this out explicitly.
Changes
While adding new types for Conditionals in ( #1031 and #1130), I found
that there are quite a few places we need to update. Documenting this for future use!
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them: