Add documentation about timeout format #1840
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
tekton-robot
added
the
size/S
Since we don't have a yaml example with duration and duration format is not very obvious, let's add a section in the documentation to document it. Signed-off-by: Chmouel Boudjnah <[email protected]>
chmouel
force-pushed
the
document-timeout
branch
from
a50d3e7 to
c2c8fa6
Compare
Add an example with a pipelinerun that has a timeout. We have in no-ci because we cannot test for failure. Signed-off-by: Chmouel Boudjnah <[email protected]>
tekton-robot
added
size/M
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: 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
afrittoli
reviewed
Jan 10, 2020
| - `1m` | ||
| - `60s` | ||
|
|
||
| The default timeout is 60 minutes, if `default-timeout-minutes` is not |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I could not figure out what is the timeout format, thinking at first that
it was seconds or another unit..
Let's add some documentation about the format and how to use it.
I have added an example for a Pipeline with timeout in
no-cisince I don't believe e2e yaml tests supports failure tests.Changes
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.
Release Notes