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 display of retries #3062

Merged
merged 1 commit into from
Aug 21, 2023
Merged

Update display of retries #3062

merged 1 commit into from
Aug 21, 2023

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Aug 21, 2023

Changes

Addresses the retries part of #1445

Update the way pipeline task retries are displayed in the Dashboard. Instead of displaying each attempt as if it were an independent TaskRun, display them as a single TaskRun as is actually the case on the cluster.

This means that users now need a new way to access logs / status etc. of previous retry attempts. Add an overflow menu on an expanded task which has retries, allowing the user to select the desired retry to view.

Keep the existing behaviour that selecting the latest attempt of an in-progress task will update to show the latest status of subsequent attempts.

The net result of this change is that the UI is a lot cleaner when retries are in play, a successful PipelineRun won't show any red / error state by default, but will still clearly communicate to the user that retries took place so they can investigate further if needed.

This change also add support for displaying retry status on the TaskRun details page which previously only showed the status of the latest attempt.

/kind feature

Before:
image

After:
image

Menu to view retry details:
image

Viewing a retry:
image

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)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Improve display of pipeline task retries on the PipelineRun details page. It's now easier to get a quick summary of the PipelineRun status as retries for a given TaskRun are collapsed into a single entry. This also adds the ability to view retry status and logs on the TaskRun details page.

@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 21, 2023
@AlanGreene
Copy link
Member Author

Failed downloading Node.js, unrelated to these changes
/test pull-tekton-dashboard-integration-tests

Update the way pipeline task retries are displayed in the Dashboard.
Instead of displaying each attempt as if it were an independent TaskRun,
display them as a single TaskRun as is actually the case on the cluster.

This means that users now need a new way to access logs / status etc. of
previous retry attempts. Add an overflow menu on an expanded task which
has retries, allowing the user to select the desired retry to view.

Keep the existing behaviour that selecting the latest attempt of an
in-progress task will update to show the latest status of subsequent
attempts.

The net result of this change is that the UI is a lot cleaner when
retries are in play, a successful PipelineRun won't show any red / error
state by default, but will still clearly communicate to the user that
retries took place so they can investigate further if needed.

This change also add support for displaying retry status on the TaskRun
details page which previously only showed the status of the latest attempt.
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 tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 21, 2023
@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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 21, 2023
@tekton-robot tekton-robot merged commit dc2429a into tektoncd:main Aug 21, 2023
@AlanGreene AlanGreene deleted the retries branch August 21, 2023 14:50
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. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants