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.

Sign up for GitHub

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

Jump to bottom

Add support for displayName from childReferences #3345

Merged
merged 1 commit into from
Mar 19, 2024
Merged

Add support for displayName from childReferences #3345

merged 1 commit into from
Mar 19, 2024

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Mar 11, 2024 •
edited
Loading

Changes

#2410
Depends on tektoncd/pipeline#7683

Update utils to support pulling the pipeline task displayName from the run's status.childReferences. This adds support for dynamic matrix display names, and provides a consistent location to retrieve the resolve display name value after param substitution etc. has taken place.

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 matrix task display names. When a `displayName` is set on a matrix task, the Dashboard will now retrieve that value from the PipelineRun status if present and display it in the task tree instead of the pipeline task name which would be the same for all instances of that matrix task. This makes it easier for users to differentiate between instances of the task without having to inspect the params or logs.

This feature requires Pipelines v0.58.0 or newer.

@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/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 11, 2024
@AlanGreene
Copy link
Member Author

Tentatively targetting Dashboard v0.45 if tektoncd/pipeline#7683 is included in Pipelines v0.58 next week and we have time to fully test it.

@AlanGreene
Copy link
Member Author

/kind feature

@tekton-robot tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 12, 2024
@AlanGreene
Copy link
Member Author

Tested with Pipelines nightly release v20240319-81ea62d876

Before:
image

After:
image

@AlanGreene
Add support for displayName from childReferences
b62ee7c 
Update utils to support pulling the pipeline task `displayName`
from the run's `status.childReferences`. This adds support for
dynamic matrix display names, and provides a consistent location
to retrieve the resolve display name value after param substitution
etc. has taken place.
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 19, 2024
@AlanGreene AlanGreene marked this pull request as ready for review March 19, 2024 12:34
@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 Mar 19, 2024
briangleeson
briangleeson approved these changes Mar 19, 2024
View reviewed changes
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 19, 2024
@tekton-robot tekton-robot merged commit a7dc50e into tektoncd:main Mar 19, 2024
8 checks passed
@AlanGreene AlanGreene deleted the childReferences_displayName branch March 19, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@briangleeson briangleeson briangleeson approved these changes

@LyndseyBu LyndseyBu Awaiting requested review from LyndseyBu

Assignees

@briangleeson briangleeson

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AlanGreene @tekton-robot @briangleeson