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

TEP-0116: Referencing Finally Task Results in Pipeline Results #5170

Merged
merged 1 commit into from
Aug 8, 2022
Merged

TEP-0116: Referencing Finally Task Results in Pipeline Results #5170

merged 1 commit into from
Aug 8, 2022

Conversation

vsinghai
Copy link
Contributor

@vsinghai vsinghai commented Jul 19, 2022 •
edited
Loading

Feature Request

This issue will track implementation of TEP-0116: Referencing Finally Task Results in Pipeline Results.

Changes

Previously, finally fields could not propagate Results
to Pipeline, whereas PipelineTasks in the Tasks field could.
To improve the parity between finally field and tasks, this
issue supports referencing Results from finally in
Pipeline Results.

This PR adds finally to the v1beta1 const field, updates logic,
adds unit tests to allow $(finally.<pipelinetask-name>.result.<result-name>)
to be valid, adds validation, and updates documentation.

/kind feature
/cc @jerop

Submitter Checklist

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

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Allow users to use `results` from `finally` in `PipelineResults` using `$(finally.<pipelinetask-name>.result.<result-name>)`

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Jul 19, 2022
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 19, 2022
@tekton-robot
Copy link
Collaborator

Hi @vsinghai. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@tekton-robot tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 19, 2022
@vsinghai
Copy link
Contributor Author

vsinghai commented Jul 19, 2022 •
edited
Loading

/hold
/cc @jerop

@jerop
Copy link
Member

jerop commented Jul 19, 2022

/hold

waiting for tektoncd/community#746 to be merged

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 19, 2022
@afrittoli
Copy link
Member

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 19, 2022
@afrittoli
Copy link
Member

Thank you @vsinghai for you PR!
Could you provide a bit more context in the PR description?

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesnt merit a release note. labels Jul 20, 2022
lbernick
lbernick reviewed Jul 21, 2022
View reviewed changes
Copy link
Member

@lbernick lbernick left a comment

Choose a reason for hiding this comment

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

Thanks @vsinghai!

Could you please update the commit message and the PR description to be more descriptive of the changes in this commit, e.g. "Add support for finally task results in pipeline results"? Please also make sure you add a commit message, and I think it would be helpful to update the PR description as well (the sentence "this issue will track implementation..." is confusing as part of a PR description).

Lastly, could you please add examples to the documentation of how this field can be used?

pkg/reconciler/pipelinerun/resources/apply_test.go Show resolved Hide resolved
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 22, 2022
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1beta1/pipeline_validation.go 100.0% 99.6% -0.4

@vsinghai
Copy link
Contributor Author

/test tekton-pipeline-unit-tests

@jerop jerop changed the title TEP-0116: Created Tests and Implementation TEP-0116: Referencing Finally Task Results in Pipeline Results Aug 2, 2022
@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 5, 2022
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@vsinghai
Copy link
Contributor Author

vsinghai commented Aug 8, 2022

/test pull-tekton-pipeline-alpha-integration-tests

@jerop
Copy link
Member

jerop commented Aug 8, 2022

TestPipelineRunTimeout is a known flake - #3460

/test pull-tekton-pipeline-alpha-integration-tests

jerop
jerop approved these changes Aug 8, 2022
View reviewed changes
Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

thanks @vsinghai 🎉

docs/pipelines.md Outdated Show resolved Hide resolved
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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 Aug 8, 2022
@vsinghai
Add support for finally task results in pipeline results
934100a 
Prior to this commit, finally tasks can emit Results but
results emitted from the finally tasks can not be configured in
the Pipeline Results.

In this commit, we add implementation for supporting finally tasks
in Pipeline results, update documentation to reflect these changes,
and add examples for the users to better understand the new
feature being added.

References [TEP-0116](tektoncd/community#746)

/kind feature
/cc @jerop
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/reconciler/pipelinerun/pipelinerun.go 85.8% 86.0% 0.2

@dibyom
Copy link
Member

dibyom commented Aug 8, 2022

/test tekton-pipeline-unit-tests

dibyom
dibyom reviewed Aug 8, 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.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 8, 2022
@tekton-robot tekton-robot merged commit 369665c into tektoncd:main Aug 8, 2022
@vsinghai
Copy link
Contributor Author

vsinghai commented Aug 8, 2022

WOOO

@vsinghai vsinghai deleted the tep branch August 8, 2022 16:11
@talife talife mentioned this pull request Dec 2, 2022
Closed
62 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lbernick lbernick lbernick left review comments

@dibyom dibyom dibyom left review comments

@jerop jerop jerop approved these changes

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@dibyom dibyom

@vsinghai vsinghai

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@vsinghai @tekton-robot @jerop @afrittoli @dibyom @lbernick