feat: Workflow title/description in workflow list view. Fixes #6529

[jmeridth]

Fixes #6529 (partially, no markdown)

• title and description in list view

TL;DR
Add the following to your workflow annotations to get a title/description to show on the workflow list page:

spec:
  annotations:
    workflows.argoproj.io/title: 'this is a title'
    workflows.argoproj.io/description: 'this is a description'

Signed-off-by: jmeridth jmeridth@gmail.com

Fixes #TODO

Please do not open a pull request until you have checked ALL of these:

• Create the PR as draft .
• Run make pre-commit -B to fix codegen and lint problems.
• Sign-off your commits (otherwise the DCO check will fail).
• Use a conventional commit message (otherwise the commit message check will fail).
• "Fixes #" is in both the PR title (for release notes) and this description (to automatically link and close the issue).
• Add unit or e2e tests. Say how you tested your changes. If you changed the UI, attach screenshots.
• Github checks are green.
• Once required tests have passed, mark your PR "Ready for review".

If changes were requested, and you've made them, dismiss the review to get it reviewed again.

[jmeridth]

STIL WIP

Getting the following error do to a collision with react-markdown and swagger-ui-react

Compiled with problems:X

ERROR

./node_modules/swagger-ui-react/swagger-ui-es-bundle-core.js 2:298485
Module parse failed: Unexpected token (2:298485)
File was processed with these loaders:
 * ./node_modules/source-map-loader/dist/cjs.js
You may need an additional loader to handle the result of these loaders.
| /*! For license information please see swagger-ui-es-bundle-core.js.LICENSE.txt */
...

And line 2, character 298485 is a ?? character (nullish coalescing operator).

...
;return e[r]??(e[r]=[]),e[r]
...

I've taken a barebones repo and just added swagger-ui as a dependency and got compilation errors also. Either I find another markdown library or figure out this issue.

Still working through it.

[alexec]

Maybe no markdown in v1? Could be a security risk, allow users to render JavaScript in other users browsers.

[jmeridth]

@alexec that sounds good to me. Will rollback the Markdown. Cheers for the suggestion.

[jmeridth]

Have an issue where, when the list refreshes the first time (based on timer?) it shows the previous workflow.metadata.name until the screen is manually refreshed. The refresh is not including the annotations I believe. Looking where this might be missing.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If this is a mentoring request, please provide an update here. Thank you for your contributions.

[terrytangyuan]

Are you still working on this?

[jmeridth]

One last hurdle this weekend. Should have the PR ready for review in the next 24 hours.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If this is a mentoring request, please provide an update here. Thank you for your contributions.

[jmeridth]

Found the issue with the refresh. Fixed. Waiting on CI and then will mark as ready for review.

[jmeridth]

@terrytangyuan could you please rerun the cancelled GitHub Action (job)? It timed out after 8mins. I don't think my change would cause that. If that can finish/pass, I'm ready for this change to be reviewed. Cheers.

Master update is doing re-run, hope it gets past the timeout now. 🤞

[jmeridth]

This was the part that I was missing on the refreshes. Old name was showing after 5 second watchlist refresh. Adding this keeps the title and description if present in the annotations on refresh.

[terrytangyuan]

Thank you!