Skip to content
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

Merged
merged 1 commit into from
Jan 24, 2020

Conversation

othomann
Copy link
Contributor

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

Provide the task run status update to reflect the new results defined in the task spec.

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Jan 22, 2020
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 22, 2020
@othomann othomann requested a review from a user January 22, 2020 23:03
Copy link

@ghost ghost left a 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:

  1. docs/tasks.md should include a Syntax sub-section called "Results". This section should include the following:

    1. 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.
    2. A description of the file path that a task should write to output a result.
    3. A short spec yaml showing usage (similar to the one you included here).
  2. docs/taskruns.md should include a sub-section under "Status" that describes the format of the results written out to the TaskRun.

  3. Add an example under examples/taskruns that utilizes results. This example will act as documentation (we should link to it from docs/tasks.md) and will also act as an end-to-end test since our examples are executed on a running cluster with each PR.

@ghost
Copy link

ghost commented Jan 23, 2020

/approve

@tekton-robot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 23, 2020
@othomann
Copy link
Contributor Author

@sbwsg you want the doc changes as part of this PR?

@ghost
Copy link

ghost commented Jan 23, 2020

yes please!

docs/taskruns.md Outdated Show resolved Hide resolved
docs/taskruns.md Show resolved Hide resolved
docs/taskruns.md Outdated Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
pkg/apis/pipeline/v1alpha1/taskrun_types.go Outdated Show resolved Hide resolved
pkg/apis/pipeline/v1alpha1/taskrun_types.go Outdated Show resolved Hide resolved
@ghost
Copy link

ghost commented Jan 24, 2020

/lgtm

@tekton-robot tekton-robot assigned ghost Jan 24, 2020
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 24, 2020
@tekton-robot tekton-robot merged commit 943aaee into tektoncd:master Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants