add ability to set "displayName" for Pipeline tasks

[itewk]

Feature request

Currently when a pipeline is rendered in the UI the Pipeline.tasks.*.name is used in the UI. The problem is that field has character requirments on it designed for a machine so it can be used for other params like runAfter. This means that the pipelines are not very human readable in the UI.

Use case

For instance when converting a pipeline from Jenkins to Tekton. had a Jenkins stage named CI: Static Image Scan: Compliance in tekton i have to name the task ci-static-image-scan-compliance and that is what gets rendered in the UI for end users rather then something nice a pretty like in jenkins.

Solution

Need a new filed, such as Pipeline.tasks.*.displayName which is optional and allows a human readable text that gets rendered in the UI if supplied instead of Pipeline.tasks.*.name.

[tekton-robot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

[itewk]

:(

[imjasonh]

/remove-lifecycle stale

This seems like a fairly straightforward FR, possibly even a [good first issue]. I think a TEP is a good next step, to get feedback and input from the community, particularly in the CLI and Dashboard areas.

If you're interested in drafting a brief TEP I can help shepherd this through the process. 👍

[itewk]

ill need a a definition of TEP, but happy to help push it along

[imjasonh]

The TEP (Tekton Enhancement Proposal) process is described here: https://github.com/tektoncd/community/blob/master/teps/0001-tekton-enhancement-proposal-process.md

Basically, write up a short Markdown document using the template, send a PR to tektoncd/community, people will discuss and (🤞) approve, then we can implement.

Since the proposal is small, just adding a field, I suspect discussion will be light, but it helps get visibility from other teams before making changes that might affect them.

[itewk]

@imjasonh tektoncd/community#319

[tekton-robot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

[itewk]

@imjasonh the TEP got merged, should this stay alive for the actual implementation or allowed to die?

[imjasonh]

/lifecycle frozen

Let's keep it open.

[jerop]

TEP-0047: Pipeline Task Display Name is implementable - we welcome contributions in implementing it

[nanjingfm]

/assign

[jerop]

Thank you @nanjingfm for implementing this feature!

Could you please update the status of TEP-0047, and add a link to the implementation PR? 🙏🏾

[nanjingfm]

Here is the pr marking tep-0047 as implemented. 😁

[Goltergaul]

is this supported by the dashboard?

[pritidesai]

Yes, this is supported by the dashboard!