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

feat: set template display name in yaml #14077

Merged
merged 24 commits into from
Jan 27, 2025

Conversation

MenD32
Copy link
Contributor

@MenD32 MenD32 commented Jan 13, 2025

Feature: set up custom names for displayName in template definition
suggested on #13886

Motivation

Customizable display names for workflow nodes in the Argo UI enhance usability by allowing users to assign intuitive, context-specific labels, improving workflow readability and navigation.

This is especially prevalent in loops.

Modifications

Added displayName field to template struct, allowing to override the default displayName.

Verification

e2e test - loops-param-argument.yaml

@MenD32 MenD32 changed the title Feat/template displayname feat: template displayname Jan 13, 2025
@MenD32 MenD32 closed this Jan 13, 2025
@MenD32 MenD32 reopened this Jan 13, 2025
@MenD32 MenD32 changed the title feat: template displayname feat: set template displayName in yaml Jan 13, 2025
@MenD32 MenD32 changed the title feat: set template displayName in yaml feat: set template display name in yaml Jan 13, 2025
@MenD32 MenD32 force-pushed the feat/template-displayname branch from b367fde to 000a881 Compare January 13, 2025 19:36
Signed-off-by: MenD32 <[email protected]>
@MenD32 MenD32 force-pushed the feat/template-displayname branch 6 times, most recently from c136f29 to 1193701 Compare January 14, 2025 12:37
Signed-off-by: MenD32 <[email protected]>
@MenD32 MenD32 force-pushed the feat/template-displayname branch from 1193701 to 83db9ba Compare January 14, 2025 12:50
MenD32 added 2 commits January 14, 2025 15:26
Signed-off-by: MenD32 <[email protected]>
…rkflows into feat/template-displayname

Signed-off-by: MenD32 <[email protected]>
@shuangkun
Copy link
Member

Could you post some screen shots?

@@ -34,6 +34,7 @@ spec:
withParam: "{{inputs.parameters.os-list}}"

- name: cat-os-release
displayName: "os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we refer to kubeflow pipeline to implement it with annotations?
https://github.com/kubeflow/pipelines/pull/2459/files

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah sure

now looks like this:

annotations: 
      workflows.argoproj.io/display-name: "os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}"

@shuangkun shuangkun added area/ui area/looping `withParams`, `withItems`, and `withSequence` labels Jan 15, 2025
@MenD32 MenD32 force-pushed the feat/template-displayname branch from e362891 to 696a7a8 Compare January 15, 2025 21:28
@MenD32 MenD32 requested a review from shuangkun January 15, 2025 21:34
@Joibel
Copy link
Member

Joibel commented Jan 20, 2025

This feature can be used more widely than loops, to add pretty names for any node?

I think this should be documented in markdown properly, rather than just in an example for one feature (loops). The "Annotations" part of the feature feels obscure as it is - what does it actually do to my pods for the different template types? And then document the special annotation that you've added here.

@MenD32
Copy link
Contributor Author

MenD32 commented Jan 23, 2025

it can be used for any node, not specifically in loops, I'll add a new page in the docs to document this.

@MenD32
Copy link
Contributor Author

MenD32 commented Jan 23, 2025

is the docs CI broken? looks like its failing spellcheck on unchanged docs...

@MenD32 MenD32 force-pushed the feat/template-displayname branch 2 times, most recently from 34d1600 to 675d698 Compare January 24, 2025 19:55
.spelling Outdated Show resolved Hide resolved
@MenD32 MenD32 force-pushed the feat/template-displayname branch 2 times, most recently from e802a10 to 2dacf13 Compare January 27, 2025 12:37
@MenD32 MenD32 force-pushed the feat/template-displayname branch from 2dacf13 to 5951b1e Compare January 27, 2025 13:00
@MenD32 MenD32 requested a review from Joibel January 27, 2025 14:41
@Joibel Joibel merged commit 5a2e08c into argoproj:main Jan 27, 2025
31 checks passed
alexec pushed a commit that referenced this pull request Jan 27, 2025
Signed-off-by: MenD32 <[email protected]>
Co-authored-by: MenD32 <[email protected]>
Signed-off-by: Alex Collins <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/looping `withParams`, `withItems`, and `withSequence` area/ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants