[TEP-0047] add display name to pipeline spec and task spec

[nanjingfm]

Changes

Before this commit, a task in a Pipeline is currently represented in the UI using a field (name) that is meant to be machine readable, not human readable. So new fields are added to Pipeline, Task, and PipelineTask for display names, as well as a new field on PipelineTask for description.

closes: #3466
/kind tep

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

• Has Docs included if any changes are user facing
• Has 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 (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 displayName field to Pipeline, Task and PipelineTask, and description field for PipelineTask.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: nanjingfm / name: nanjingfm (925b286)

[tekton-robot]

Hi @nanjingfm. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	94.8%	95.0%	0.2
pkg/apis/pipeline/v1beta1/task_conversion.go	94.4%	94.6%	0.1

[dibyom]

/ok-to-test

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	94.8%	95.0%	0.2
pkg/apis/pipeline/v1beta1/task_conversion.go	94.4%	94.6%	0.1

[JeromeJu]

Looks like we need to run ./hack/updated-codegen :)

[JeromeJu]

Thanks for the thorough change on both apiversions including the conversions 😎 🙏

For the release note, suggest that shall we use "add displayName to pipeline.spec, pipeline.spec.tasks.description and pipeline.spec.tasks.displayName" and same for the Tasks.

Also NIT for the commit message, shall we use explicitly description and displayName instead of calling out adding a new field?

[jerop]

@itewk this is an implementation of TEP-0047 - please take a look 🙏🏾

[itewk]

@jerop first, THANK YOU! this is awesome you are taking this on.

i presume the rendering of tasks / pipelines in UI is done by a different system which would need to actaully take advantage of these new fields? or am i missing something in the commit where it actaully changes the rendering to use these fields if set and/or do you have a picture of how this renders now?

[jerop]

@itewk - to clarify, it is @nanjingfm who's implementing the feature, I was just looping you in

yes, the rendering is handled by tektoncd/dashboard so they will need to support this feature once it's available in a release - cc @AlanGreene @tektoncd/dashboard-maintainers

[itewk]

@nanjingfm all my thanks to you!!

@jerop thanksnfor clarification. From a CRD perspective then this looks great to me.

[AlanGreene]

Thanks for the heads up @jerop, @tektoncd/cli-maintainers may also be interested.

I've created tektoncd/dashboard#2792 to track the Dashboard implementation.

Any input on how / where users might expect to see these new values would be welcome and can be shared on the Dashboard issue.

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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:

• OWNERS [vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[Yongxuanzhang]

Thank you so much for working on this! I wonder if we could add a simple example in docs, and also an example to use all the new fields in https://github.com/tektoncd/pipeline/tree/main/examples?

[QuanZhang-William]

Thanks @nanjingfm! Could you please add the new fields to the conversion unit tests?

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[nanjingfm]

@QuanZhang-William Unit tests and sample code have been added，I would appreciate it if you could review it again.

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[jerop]

please squash the 4 commits into 1: "Use one commit per PR" - standards

here are some guidelines for the commit message: https://github.com/tektoncd/community/blob/main/standards.md#commit-messages

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipeline_conversion.go	96.4%	96.5%	0.1
pkg/apis/pipeline/v1beta1/task_conversion.go	97.4%	97.4%	0.1

[jerop]

/lgtm

[jerop]

Thanks for the contribution @nanjingfm, and welcome to the Tekton community!

/meow

[tekton-robot]

@jerop:

In response to this:

Thanks for the contribution @nanjingfm, and welcome to the Tekton community!

/meow

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[itewk]

@nanjingfm WAHOOO!! thank you!