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

Improve display of skipped tasks #3651

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Sep 27, 2024

Changes

Note

This PR addresses a current gap in functionality, surfacing important information to the user to help understand the behaviour of a given pipeline / pipeline run.

It is a work in progress of one potential tactical change to improve the display of skipped tasks in the short term.
The design and/or approach may change drastically before it is merged.

However, a much larger and far-reaching redesign of the PipelineRun details page is still planned, see #2306 for details of some of the identified aspects. That change will likely involve updates to the navigation structure of the task list, the display of logs, and may also impact the way the 'skipped' status is surfaced.

Resolves #2293
Resolves #1445

When a task is skipped ensure this is communicated to the user instead of leaving it showing as 'pending'.

In the case of when expressions, surface details of the when expression so the user can undertsand the reason for the task being skipped. Also remove elements that will never have content in this case such as the pod tab on the TaskRun details view, and replace the log container with a message indicating that the task was skipped and no logs will be available.

Update the status icons and labels to differentiate between pending / not run and skipped.

Apply similar changes for step-level when expressions which rely on the step actions feature being enabled.

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

NONE

@tekton-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 27, 2024
@AlanGreene AlanGreene force-pushed the when-expressions branch 2 times, most recently from a5cdeb6 to f442079 Compare October 21, 2024 12:28
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 21, 2024
@AlanGreene
Copy link
Member Author

/test all

@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 21, 2024
@AlanGreene
Copy link
Member Author

/test all

@AlanGreene AlanGreene force-pushed the when-expressions branch 2 times, most recently from 941d171 to 39fc8a3 Compare October 22, 2024 12:46
@AlanGreene AlanGreene marked this pull request as ready for review October 22, 2024 12:59
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 22, 2024
@AlanGreene AlanGreene requested review from LyndseyBu and removed request for skaegi October 22, 2024 12:59
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.

One question but otherwise lgtm

When a task is skipped ensure this is communicated to the user
instead of leaving it showing as 'pending'.

In the case of when expressions, surface details of the when
expression so the user can undertsand the reason for the task
being skipped. Also remove elements that will never have content
in this case such as the pod tab on the TaskRun details view,
and replace the log container with a message indicating that
the task was skipped and no logs will be available.

Update the status icons and labels to differentiate between
pending / not run and skipped.

Apply similar changes for step-level when expressions which rely
on the step actions feature being enabled.
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 Oct 22, 2024
@tekton-robot tekton-robot merged commit 1e2bfc9 into tektoncd:main Oct 22, 2024
8 checks passed
@AlanGreene AlanGreene deleted the when-expressions branch October 22, 2024 14:26
@AlanGreene AlanGreene added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 22, 2024
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.

Skipped tasks shown as pending Improve display of when expressions and retries
3 participants