TEP-0103: Skipping Reason

[chitrangpatel]

Changes

Add SkippingReason to SkippedTasks field of PipelineRunStatus.

Prior to this, users only knew that a PipelineTask was skipped but not
the exact reason for skipping the task leading to confusion when
debugging Pipelines.

This PR addresses the TEP and issue. It adds a field Reason of type SkippingReason (a string alias) to the SkippedTasksfield in PipelineRunStatus. The tests have been updated to validate skipping reason.

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.

[tekton-robot]

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.

[dibyom]

/ok-to-test

[dibyom]

Closed by mistake

[dibyom]

/assign @jerop

[dibyom]

/ok-to-test

[tekton-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign jerop
You can assign the PR to them by writing /assign @jerop in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[chitrangpatel]

/retest

[dibyom]

/retest

[jerop]

@chitrangpatel - thank you!

Please squash the commits into one and write a description, as described in the commit messages standards - this could be the summary from TEP-0103.

Today, we add the when expressions to skippedTasks when a PipelineTask is skipped regardless of the reason - this is useful for users to deduce whether the reason was its when expressions or not. Now that the reason is explicit, we can add the when expressions only when it's skipped because of when expressions evaluating to false. This ensures that we provide the necessary information only, and helps keep the PipelineRun status minimal as described in TEP-0100. This can be done as follow up work after this PR is merged.

(cc @pritidesai)

[jerop]

Closes #4738

[jerop]

please update lines 666-668 as well to indicate that a Reason field will be added

[chitrangpatel]

Done.

[chitrangpatel]

Closing this PR due to merge commits affecting a squash-down.
Opening a new PR #4829 instead.

[afrittoli]

Hello @chitrangpatel and thank you for your PR.

Opening a new PR is fine, however it has the downside of dispersing the context across multiple PRs.

For next time, if you have an issue on your local branch, you can still use the existing PR.
Once you have a working local branch, you can push it to your existing PR, for instance:

git push <fork remote name> <local branch name:existing pr branch> --force

In the case of this PR, the existing pr branch would be TEP-0103-Skipping-Reason

[chitrangpatel]

Thanks @afrittoli! I will do that next time.