Document that Task Results dont get trimmed #2942
Conversation
The contents of task results are not processed by Tekton in any way - leading and trailing whitespace characters are emitted verbatim from files written to /tekton/results. This commit adds documentation to make clear that Tekton does not process result contents in any way. In addition, I've added a short intro to the beginning of the results section to give some focus on what results are useful for.
tekton-robot
added
the
release-note-none
tekton-robot
added
the
size/S
|
/kind documentation |
tekton-robot
added
the
kind/documentation
| @@ -387,9 +387,22 @@ and the [`Workspaces` in a `TaskRun`](../examples/v1beta1/taskruns/workspace.yam | |||
|
|
|||
| ### Emitting results | |||
There was a problem hiding this comment.
/lgtm
one more section on Consuming Results might be helpful as well, emphasizing that the consumer task ends up having dependency on the emitting results task and executed after the dependencies are executed successfully.
(if not documented anywhere 🙏 and could be separate PR)
There was a problem hiding this comment.
There are a couple of places where it looks like we describe how results appear:
- The TaskRun doc describes a bit about their appearance in the Status section of the resource.
- The Pipeline doc describes a bit about referencing results between tasks and mentions the task ordering.
I think that Pipeline doc could use a bit of work to make it a tad clearer. I also notice that the link from there to this doc's results section is broken. I'll make a PR for that. Good call, thanks @pritidesai !
|
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
Changes
Fixes #2936
The contents of task results are not processed by Tekton in any way - leading
and trailing whitespace characters are emitted verbatim from files written to
/tekton/results.
This commit adds documentation to make clear that Tekton does not process result
contents in any way.
In addition, I've added a short intro to the beginning of the results section
to give some focus on what results are useful for.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
Release Notes