-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Update task run status with results #1921
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code looks great.
Now that this feature is more fully supported I suggest we add info to the user-facing docs:
-
docs/tasks.md
should include a Syntax sub-section called "Results". This section should include the following:- a description of "results"' purpose. Something short like "Results allow a Task to output string data" is fine for now because that data can't be used in subsequent tasks yet.
- A description of the file path that a task should write to output a result.
- A short spec yaml showing usage (similar to the one you included here).
-
docs/taskruns.md
should include a sub-section under "Status" that describes the format of the results written out to the TaskRun. -
Add an example under
examples/taskruns
that utilizes results. This example will act as documentation (we should link to it fromdocs/tasks.md
) and will also act as an end-to-end test since our examples are executed on a running cluster with each PR.
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbwsg 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 |
@sbwsg you want the doc changes as part of this PR? |
yes please! |
/lgtm |
Changes
Corresponding changes to update the task run status with the new results from the task spec.
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.
Release Notes