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

Update components to support displaying new Cancelled status #2316

Merged

Conversation

AlanGreene
Copy link
Member

Changes

TEP-0058 Graceful Termination deprecated the existing PipelineRunCancelled
status. Instead, runs have the status reason Cancelled.

The feature is still in alpha, so to test it out you can edit the feature-flags
ConfigMap to set enable-api-fields: alpha, then use one of the following values
when cancelling the PipelineRun:

  • Cancelled replaces the existing PipelineRunCancelled, interrupts any
    executing tasks and does not run finally tasks
  • StoppedRunFinally lets any executing tasks complete normally but does not
    start any new non-finally tasks, then runs finally tasks
  • CancelledRunFinally interrupts any executing non-finally tasks, then executes
    finally tasks

In all 3 cases above, the PipelineRun status reason is Cancelled

Update tests and storybook to include 'Cancelled' variants.

The Dashboard API will still use PipelineRunCancelled to stop a PipelineRun.
A future change once the feature has been promoted to beta will switch to the
replacement Cancelled value. Some UI change may also be made to support the
alternative behaviours, tracking this in #2094

Submitter Checklist

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

See the contribution guide
for more details.

@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 28, 2022
@AlanGreene AlanGreene requested review from briangleeson and removed request for skaegi and steveodonovan February 28, 2022 17:11
TEP-0058 Graceful Termination deprecated the existing `PipelineRunCancelled`
status. Instead, runs have the status reason `Cancelled`.

The feature is still in alpha, so to test it out you can edit the `feature-flags`
ConfigMap to set `enable-api-fields: alpha`, then use one of the following values
when cancelling the PipelineRun:
- `Cancelled` replaces the existing `PipelineRunCancelled`, interrupts any
  executing tasks and does not run finally tasks
- `StoppedRunFinally` lets any executing tasks complete normally but does not
  start any new non-finally tasks, then runs finally tasks
- `CancelledRunFinally` interrupts any executing non-finally tasks, then executes
  finally tasks

In all 3 cases above, the PipelineRun status reason is `Cancelled`

Update tests and storybook to include 'Cancelled' variants.

The Dashboard API will still use `PipelineRunCancelled` to stop a PipelineRun.
A future change once the feature has been promoted to beta will switch to the
replacement `Cancelled` value. Some UI change may also be made to support the
alternative behaviours, tracking this in tektoncd#2094
@AlanGreene AlanGreene force-pushed the graceful_termination_display branch from b25b4b7 to 7ad4646 Compare March 1, 2022 12:04
Copy link
Contributor

@briangleeson briangleeson 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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

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 lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 1, 2022
@tekton-robot tekton-robot merged commit 8913256 into tektoncd:main Mar 1, 2022
@AlanGreene AlanGreene deleted the graceful_termination_display branch March 1, 2022 12:20
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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants