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

Add documentation about timeout format #1840

Merged
merged 2 commits into from
Jan 10, 2020
Merged

Add documentation about timeout format #1840

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2c8fa6
Add documentation about timeout format
chmouel Jan 10, 2020
939b981
Add pipelinerun example with timeout
chmouel Jan 10, 2020
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
20 changes: 16 additions & 4 deletions docs/taskruns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,22 @@ The `paths` field can be used to [override the paths to a resource](./resources.

### Configuring Default Timeout

You can configure the default timeout by changing the value of `default-timeout-minutes`
in [`config/config-defaults.yaml`](./../config/config-defaults.yaml). The default timeout
is 60 minutes, if `default-timeout-minutes` is not available. There is no timeout by
default, if `default-timeout-minutes` is set to 0.
You can configure the default timeout by changing the value of
`default-timeout-minutes` in
[`config/config-defaults.yaml`](./../config/config-defaults.yaml).

The `timeout` format is a `duration` as validated by Go's
[`ParseDuration`](https://golang.org/pkg/time/#ParseDuration), valid format for
examples are :

- `1h30m`
- `1h`
- `1m`
- `60s`

The default timeout is 60 minutes, if `default-timeout-minutes` is not
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 find this sentence a bit confusing, maybe because it's about the default value of the default timeout :P

When default-timeout-minutes is not set, default timeout is 60 minutes.
There is no default timeout if default-timeout-minutes is set to 0.

available. There is no timeout by default, if `default-timeout-minutes` is set
to 0.

### Service Account

Expand Down