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.

Sign up for GitHub

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

Jump to bottom

Results Lifecycle #5070

Merged
merged 1 commit into from
Aug 3, 2022
Merged

Results Lifecycle #5070

merged 1 commit into from
Aug 3, 2022

Conversation

chitrangpatel
Copy link
Contributor

@chitrangpatel chitrangpatel commented Jul 4, 2022 •
edited
Loading

This document walks a developer through how the results are stored
by the tasks and extracted by the taskrun reconciler.

Changes

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in
    (if there are no user facing changes, use release note "NONE")

Release Notes

Documenting the results lifecycle.

@tekton-robot tekton-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 4, 2022
@chitrangpatel
Copy link
Contributor Author

/assign @dibyom
cc @chuangw6 @Yongxuanzhang

@chitrangpatel
Copy link
Contributor Author

/retest-required

@chitrangpatel
Copy link
Contributor Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 4, 2022
@chitrangpatel
Copy link
Contributor Author

/retest

@Yongxuanzhang
Copy link
Member

Yongxuanzhang commented Jul 6, 2022 •
edited
Loading

I think overall this looks correct!

  1. Are you planning to include how we handle larger results in this doc once it is merged?
  2. I wonder if it makes sense to include how results used in pipeline? It may consist of 1) How results are referred in another task (the reference will add a link to our tasks DAG), 2) How pipeline level results are emitted
  3. Maybe add some reference to results section to other docs, or in other parts link to this doc as a reference for developers

@chitrangpatel
Copy link
Contributor Author

I think overall this looks correct!

  1. Are you planning to include how we handle larger results in this doc once it is merged?
    Yes, once its merged, I can add to it.
  1. I wonder if it makes sense to include how results used in pipeline? It may consist of 1) How results are referred in another task (the reference will add a link to our tasks DAG), 2) How pipeline level results are emitted

I'm not super familiar with the referencing of results so feel free to add to it once this PR is merged. I would like to know how that works.

  1. Maybe add some reference to results section to other docs, or in other parts link to this doc as a reference for developers
    I agree.

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jul 6, 2022
dibyom
dibyom approved these changes Jul 6, 2022
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chitrangpatel

docs/developers/results-lifecycle.md Outdated Show resolved Hide resolved
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 Jul 6, 2022
@abayer
Copy link
Contributor

abayer commented Jul 21, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 21, 2022
@chitrangpatel
Results Lifecycle
511ac38 
This document walks a developer through how the results are stored
by the tasks and extracted by the taskrun reconciler.
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2022
@lbernick
Copy link
Member

lbernick commented Aug 3, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 3, 2022
@tekton-robot tekton-robot merged commit 143cc2c into tektoncd:main Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@vdemeester vdemeester Awaiting requested review from vdemeester

Assignees

@abayer abayer

@dibyom dibyom

@lbernick lbernick

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@chitrangpatel @Yongxuanzhang @tekton-robot @abayer @lbernick @dibyom