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

Add support for TEP-0047 'displayName' #2981

Merged
merged 1 commit into from
Jul 10, 2023

Conversation

AlanGreene
Copy link
Member

Changes

Resolves #2792

When viewing a Pipeline or Task details page, include the 'displayName' alongside the 'description' if provided.

On the PipelineRun details page, show the 'displayName' in the TaskTree instead of the pipelineTaskName. This also accounts for retries where the 'displayName' is used as the base instead.

The details to the right still show the full TaskRun name as before.

A future change may include display of the pipelineTask description so this is wired up but its display is omitted for now.

/kind feature

Before:
image

After:
image

Retries:
image

Also supports a mixture of pipeline tasks with displayName and without:
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

Add support for TEP-0047 Pipeline Task Display Name - the display name is shown in the task navigation on the PipelineRun details page

When viewing a Pipeline or Task details page, include the
'displayName' alongside the 'description' if provided.

On the PipelineRun details page, show the 'displayName' in the
TaskTree instead of the pipelineTaskName. This also accounts for
retries where the 'displayName' is used as the base instead.

The details to the right still show the full TaskRun name as before.

A future change may include display of the pipelineTask description
so this is wired up but its display is omitted for now.
@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 7, 2023
@AlanGreene
Copy link
Member Author

/test tekton-dashboard-unit-tests

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 Jul 10, 2023
@tekton-robot tekton-robot merged commit 74b0b0d into tektoncd:main Jul 10, 2023
3 checks passed
@AlanGreene AlanGreene deleted the tep0047_displayName branch July 10, 2023 11:14
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TEP-0047: Pipeline Task Display Name
3 participants