Fix Example with Completed and Succeeded Execution Status #4140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Today, an example `pipeline` that demonstrates using the execution status of `tasks` - `$(tasks.status)` - in `when` expressions in `finally tasks` uses `Succeeded` in a `Task` that should be executed but the status is actually `Completed`. This example would be confusing to users as reported on Slack. As explained in the [docs](https://github.com/tektoncd/pipeline/blob/release-v0.24.x/docs/pipelines.md#using-aggregate-execution-status-of-all-tasks): - `Succeeded`: all `tasks` have succeeded - `Failed`: one ore more `tasks` failed - `Completed`: all `tasks` completed successfully including one or more skipped `tasks` In this change: - correct the `task` that should be executed to check `Completed` instead of `Succeeded` - add a `finally task` that shows `Succeeded` would block execution because the aggregate execution status is actually `Completed`
tekton-robot
added
the
release-note
tekton-robot
added
size/S
pritidesai
approved these changes
Aug 5, 2021
tekton-robot
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pritidesai, 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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Today, an example
pipelinethat demonstrates using the executionstatus of
tasks-$(tasks.status)- inwhenexpressions infinally tasksusesSucceededin aTaskthat should be executedbut the status is actually
Completed. This example would be confusingto users as reported on Slack - thanks Hussein!
As explained in the docs:
Succeeded: alltaskshave succeededFailed: one ore moretasksfailedCompleted: alltaskscompleted successfully including one or moreskipped
tasksIn this change:
taskthat should be executed to checkCompletedinstead of
Succeededfinally taskthat showsSucceededwould block executionbecause the aggregate execution status is actually
Completed/kind misc
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes