Skip to content

Commit

Permalink
Document CloudEvents config (#40)
Browse files Browse the repository at this point in the history
* Document CloudEvents config
  • Loading branch information
ThomasVitale committed Jul 9, 2023
1 parent d72375f commit 621e464
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/cloud-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# CloudEvents

Tekton Pipelines can generate CloudEvents for `TaskRun`, `PipelineRun` and `CustomRun` lifecycle events.

The generation of events for `TaskRun` and `PipelineRun` is automatically enabled only if a URL has been configured for the CloudEvents sink. For example, you can use [Knative Eventing](https://knative.dev/docs/eventing) to set up a listener for such events.

```yaml
config-defaults:
default-cloud-events-sink: "<cloud-events-sink-url>"
```

If you also want Tekton Pipelines to generate CloudEvents for `CustomRun`, you need to enable the dedicated feature.

```yaml
feature-flags:
send-cloudevents-for-runs: "true"
```

0 comments on commit 621e464

Please sign in to comment.