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

Set status to succeeded when the reason is Completed #2420

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

chmouel
Copy link
Member

@chmouel chmouel commented Nov 5, 2024

When a task is skipped in a when expression, the reason becomes Completed, which shows as succeeded (Completed). This can be confusing compared to other tasks that are succeeded but not completed.

Users would not be able to tell the difference when they essentially mean the same thing.

Therefore, set the status to succeeded when the reason is Completed without displaying the reason.

This was how the pipelinerun would show when it's completed:

image

which makes it confusing since we don't know what happen, why some pr are completed and not completed but successfull? this pr fix this since they are successfull we don't need to know more than that.

This is how it looks like now:

image

Further improvement perhaps would be to add support for when expression in tkn pr show

Changes

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Run the code checkers with make check
  • Regenerate the manpages, docs and go formatting with make generated
  • Commit messages follow commit message best practices

See the contribution guide
for more details.

Release Notes

when a pipelinerun is succeeded and have a reason of completed (due of a when condition) we don't show the completed reason to avoid confusion

When a task is skipped, the reason becomes Completed, which shows as
succeeded (Completed). This can be confusing compared to other tasks
that are succeeded but not completed.

Users would not be able to tell the difference when they essentially
mean the same thing.

Therefore, set the status to succeeded when the reason is Completed
without displaying the reason.
@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Nov 5, 2024
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 5, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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 Nov 5, 2024
@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 6, 2024
@tekton-robot tekton-robot merged commit 630441f into tektoncd:main Nov 6, 2024
8 checks passed
@chmouel chmouel deleted the set-completed-as-succeded branch November 26, 2024 11:30
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. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants