Document Tekton's Many Variables #2358
Conversation
ghost
added
the
kind/documentation
googlebot
added
the
cla: yes
tekton-robot
added
the
size/L
ghost
removed request for
|
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
[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
| | `params.<param name>` | The value of the param at runtime. | | ||
| | `resources.inputs.<resource name>.path` | The path to the input resource's directory. | | ||
| | `resources.outputs.<resource name>.path` | The path to the output resource's directory. | | ||
| | `results.<result name>.path` | The path to the file where a Task's result should be written. | |
There was a problem hiding this comment.
I thought it was possible for a Task to refer to another task results now?
There was a problem hiding this comment.
Something like:
tasks.[task-name].results.[result-name]
There was a problem hiding this comment.
Ah, this is a Pipeline Task variable, which got pushed down under the PipelineResource variables since they're Task-only i think. I'll move the Pipeline variables up higher.
There was a problem hiding this comment.
Oh, right, I missed that, thank you!
|
excellent point on linking from another doc, i'll do that. |
ghost
added
the
needs-cherry-pick
Tekton exposes a number of variables in Tasks and Pipelines that are substituted for their runtime values. The complete set of variables isn't documented in any single place. This commit introduces a doc to try and capture all the variables in one place.
|
I've updated with links from other docs and also moved the Pipeline Variables to the top of the doc. |
|
/test pull-tekton-pipeline-build-tests |
|
/test pull-tekton-pipeline-build-tests |
ghost
removed
the
needs-cherry-pick
Changes
Closes #2267
Tekton exposes a number of variables in Tasks and Pipelines that are substituted for their runtime values. The complete set of variables isn't documented in any single place.
This commit introduces a doc to try and capture all the variables in one place.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
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.