Add Argo workflow title & description support #2628
Conversation
| ) | ||
| self.enable_heartbeat_daemon = enable_heartbeat_daemon | ||
| self.enable_error_msg_capture = enable_error_msg_capture | ||
| self.workflow_title = workflow_title |
There was a problem hiding this comment.
consider keeping the title as the current.project_flow_name or current.flow_name and description as the doc strring of the flow
title defaults to `current.project_flow_name` description defaults to flow's docstring
| @click.option( | ||
| "--workflow-title", | ||
| default=None, | ||
| type=str, | ||
| help="Custom title for the workflow displayed in Argo Workflows UI. Defaults to `project_flow_name`. Supports markdown formatting.", | ||
| ) | ||
| @click.option( | ||
| "--workflow-description", | ||
| default=None, | ||
| type=str, | ||
| help="Custom description for the workflow displayed in Argo Workflows UI. Defaults to the flow's docstring if available. Supports markdown formatting and multi-line text.", | ||
| ) |
There was a problem hiding this comment.
Is there an existing use-case for the CLI options for setting custom title/description that warrants adding these as well? Not opposed to adding this.
There was a problem hiding this comment.
The markdown support does not seem to be working, unless there's something off with my argo setup?
- markdown in custom title/description is not being formatted in Argo UI
- multi-line descriptions are rendered as one-liners (e.g. multi-line docstring)
There was a problem hiding this comment.
Is there an existing use-case for the CLI options for setting custom title/description that warrants adding these as well? Not opposed to adding this.
The CLI flags let users provide concise, meaningful titles and descriptions (e.g. ETL [Prod], ML Pipeline v2.3.1) without changing code or flow names. It’s fully optional and backward-compatible, just giving flexibility for UI readability and dynamic deployments.
The markdown support does not seem to be working, unless there's something off with my argo setup?
- markdown in custom title/description is not being formatted in Argo UI
- multi-line descriptions are rendered as one-liners (e.g. multi-line docstring)
Verified working with Argo Workflows v3.6+ - headers, bold/italic, and multi-line formatting render correctly. Older UI versions may flatten multi-line text.
fixes #2626
Adds support for Argo Workflow Title & description.