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-0103: Skipping Reason - Add SkippingReason to SkippedTasks field of PipelineRunStatus #4829

Merged
merged 1 commit into from
May 5, 2022
Merged

TEP-0103: Skipping Reason - Add SkippingReason to SkippedTasks field of PipelineRunStatus #4829

merged 1 commit into from
May 5, 2022

Conversation

chitrangpatel
Copy link
Contributor

@chitrangpatel chitrangpatel commented May 3, 2022 •
edited
Loading

TEP-0103: Skipping Reason : Add SkippingReason to SkippedTasks field of PipelineRunStatus.

Today, users only know that a PipelineTask was skipped, but they don't know for which exact reason.
This can be confusing when debugging Pipelines. In this PR, we add the reason for skipping to the
SkippedTasks field in PipelineRunStatus to improve usability and debuggability.

Changes

This commit adds a field Reason of type SkippingReason (a string alias) to the SkippedTasks field in PipelineRunStatus.

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

Add SkippingReason to SkippedTasks field of PipelineRunStatus. This enables users to know the exact reason why a given PipelineTask was skipped.

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label May 3, 2022
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 3, 2022
@tekton-robot
Copy link
Collaborator

Hi @chitrangpatel. 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 May 3, 2022
@chitrangpatel chitrangpatel changed the title Skipping Reason included in the SkippedTasks field of PipelineRunStatus TEP-0103: Skipping Reason : Add SkippingReason to SkippedTasks field of PipelineRunStatus. May 3, 2022
@chitrangpatel
Copy link
Contributor Author

/assign @dibyom
/assign @jerop

@chitrangpatel chitrangpatel mentioned this pull request May 3, 2022
Closed
5 tasks
@jerop jerop added this to the Pipelines v0.36 milestone May 3, 2022
@jerop
Copy link
Member

jerop commented May 3, 2022

/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 May 3, 2022
@jerop jerop changed the title TEP-0103: Skipping Reason : Add SkippingReason to SkippedTasks field of PipelineRunStatus. TEP-0103: Skipping Reason - Add SkippingReason to SkippedTasks field of PipelineRunStatus May 3, 2022
jerop
jerop reviewed May 3, 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 @chitrangpatel - left a few comments, please update the commit message (the first two paragraphs should be enough)

pkg/pod/status_test.go Outdated Show resolved Hide resolved
test/pipelinefinally_test.go Outdated Show resolved Hide resolved
@chitrangpatel
Copy link
Contributor Author

thanks @chitrangpatel - left a few comments, please update the commit message (the first two paragraphs should be enough)

Done!

@chitrangpatel
Copy link
Contributor Author

/retest

1 similar comment
@chitrangpatel
Copy link
Contributor Author

/retest

jerop
jerop approved these changes May 4, 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.

thank you @chitrangpatel!

@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 May 4, 2022
@chitrangpatel
Copy link
Contributor Author

/retest

lbernick
lbernick reviewed May 5, 2022
View reviewed changes
docs/pipelineruns.md Outdated Show resolved Hide resolved
@chitrangpatel
Skipping Reason included in the SkippedTasks field of `PipelineRunS…
a02fa96 
…tatus`.

Today, users only know that a PipelineTask was skipped, but they don't know for which exact reason.
This can be confusing when debugging Pipelines. In this PR, we add the reason for skipping to the
SkippedTasks field in PipelineRunStatus to improve usability and debuggability.

This commit adds a field `Reason` of type [`SkippingReason`][reasons] (a string alias) to the [`SkippedTasks`][skipped-tasks] field in `PipelineRunStatus`.
lbernick
lbernick reviewed May 5, 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.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2022
@chitrangpatel
Copy link
Contributor Author

/retest

@tekton-robot tekton-robot merged commit a3caabf into tektoncd:main May 5, 2022
@jerop jerop mentioned this pull request May 5, 2022
Merged
@lbernick lbernick mentioned this pull request May 9, 2022
Closed
@AlanGreene AlanGreene mentioned this pull request May 9, 2022
Closed
@afrittoli afrittoli mentioned this pull request May 9, 2022
Closed
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

@jerop jerop jerop approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@imjasonh imjasonh Awaiting requested review from imjasonh

Assignees

@dibyom dibyom

@jerop jerop

@lbernick lbernick

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.36
Development

Successfully merging this pull request may close these issues.
5 participants
@chitrangpatel @tekton-robot @jerop @lbernick @dibyom