Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jason Hall <jasonhall@redhat.com>
  • Loading branch information
ScrapCodes and imjasonh authored Aug 5, 2021
1 parent e076b47 commit 67feaa3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,18 +180,18 @@ Supporting timeouts is optional but recommended.

#### Developer guide for custom controllers supporting `Timeout`

1. A tektoncd owned controller will never directly update the status of the
1. Tekton controllers will never directly update the status of the
`Run`, it is the responsibility of the custom task controller to support
timeout.
timeout. If timeouts are not supported, it's the responsibility of the custom
task controller to reject `Run`s that specify a timeout value.
2. On a `pipelineRun` or `pipelineTask` timeout, the status of the
`Run.Spec.Status` is updated to `RunCancelled`. It is upto the custom task
controller, to respond to it. An existing controller, which does not yet
`Run.Spec.Status` is updated to `RunCancelled`. It is up to the custom task
controller to respond to it. An existing controller, which does not yet
support timeout, will be able to cleanup, if it supports a cancel.
3. A Custom Task author can watch for this status update
(i.e. `Run.Spec.Status == RunCancelled`) and or `Run.HasTimedOut()` and take
any corresponding actions ( i.e. a clean up e.g., cancel a cloud build, stop
any corresponding actions (i.e. a clean up e.g., cancel a cloud build, stop
the waiting timer, tear down the approval listener).

### Specifying `Parameters`

If a custom task supports [`parameters`](tasks.md#parameters), you can use the
Expand Down

0 comments on commit 67feaa3

Please sign in to comment.