Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs with additional steps for adding new types #1133

Merged
merged 1 commit into from
Jul 29, 2019
Merged

Update docs with additional steps for adding new types #1133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

e.g [condition_types.go](./pkg/apis/pipeline/v1alpha1/condition_types.go)
1. Register it with the [webhook](./cmd/webhook/main.go)
1. Add the new type to the [list of known types](./pkg/apis/pipeline/v1alpha1/register.go)

_See [the API compatibility policy](api_compatibility_policy.md)._