TEP-0090: Matrix - Update Pipeline API definition
#4601
Conversation
tekton-robot
added
release-note
tekton-robot
added
the
size/L
|
/lgtm |
While adding documentation for `Matrix`, as proposed in [TEP-0090][tep-0090], found a couple of issues with the existing `Pipelines` documentation. Most important is that the `Pipeline` API definition is missing some fields, see [doc][doc]. This commit has the documentation updates that are not directly related to `Matrix`, but are needed to prepare to add the `Matrix` docs. In this change, we update the `Pipeline` API definition to reflect all the existing fields. We also include other fixes in the `Pipelines` documentation, including removing confusing use of name `parameter` to refer to `field`. [tep-0090]: https://github.com/tektoncd/community/blob/main/teps/0090-matrix.md [doc]: https://github.com/tektoncd/pipeline/blob/62c9b0d861bd2ae01263dfa67ba41fb0fa2bc9a9/docs/pipelines.md#configuring-a-pipeline
jerop
force-pushed
the
tep-0090-refactor-docs
branch
from
e263b61
to
de75481
Compare
| - [`name`](#adding-finally-to-the-pipeline) - the name of this `Task` within the context of this `Pipeline`. | ||
| - [`taskRef`](#adding-finally-to-the-pipeline) - a reference to a `Task` definition. | ||
| - [`taskSpec`](#adding-finally-to-the-pipeline) - a specification of a `Task`. | ||
| - [`retries`](#using-the-retries-field) - Specifies the number of times to retry the execution of a `Task` after |
There was a problem hiding this comment.
@vdemeester, here is the answer to your question 🤣 finally does support retries 😄
There was a problem hiding this comment.
haha yea, had to test it out to prove we support retries, was confused given our discussion yesterday at pipeline wg 😀
There was a problem hiding this comment.
thanks you @jerop 👍 we need similar updates to https://github.com/tektoncd/pipeline/blob/main/docs/tasks.md#configuring-a-task 😄
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pritidesai 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
|
/lgtm |
|
/test pull-tekton-pipeline-alpha-integration-tests |
Changes
While adding documentation for
Matrix, as proposed in TEP-0090,found a couple of issues with the existing
Pipelinesdocumentation. Mostimportant is that the
PipelineAPI definition is missing some fields, seedoc. This commit has the documentation updates that are not directly
related to
Matrix, but are needed to prepare to add theMatrixdocs.In this change, we update the
PipelineAPI definition to reflect all theexisting fields. We also include other fixes in the
Pipelinesdocumentation,including removing confusing use of name
parameterto refer tofield./kind documentation
Issue: #2050
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes