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

Quote step names to work around mermaid-js/mermaid#2495 #77

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chancez
Copy link

@chancez chancez commented Jul 23, 2024

Fixes #76

I still need to see if I can test this with our existing workflows, but I figured I would open a PR for feedback since I don't really have any experience using mermaid charts myself, and perhaps there's a better alternative.

chancez added a commit to cilium/cilium that referenced this pull request Jul 23, 2024
…-action

Running on my branch of the workflow-telemetry-action with
catchpoint/workflow-telemetry-action#77 to see
if it can help the rendering problem in #32241.

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
Fixes catchpoint#76

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
@chancez chancez force-pushed the pr/chancez/quote_step_names branch from d41dfbc to 881045c Compare July 24, 2024 00:09
@chancez
Copy link
Author

chancez commented Jul 24, 2024

Ok so that worked. @serkan-ozal could you take a look?

chancez added a commit to cilium/cilium that referenced this pull request Jul 30, 2024
Basically, workflow telemetry uses step names for gantt charts which
uses Github's native support for mermaidjs for rendering the charts in
issues and PRs. However mermaidjs has an issue
(mermaid-js/mermaid#2495) when you use
mermaid reserved keywords in node names/text.

To fix rendering of the ipsec upgrade workflow's telemetry, avoid the
use of the "call" keyword.

This is a work around for catchpoint/workflow-telemetry-action#76.
If an when catchpoint/workflow-telemetry-action#77 is merged, we do not need to be concerned with workflow step names.

Fixes #32241

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
github-merge-queue bot pushed a commit to cilium/cilium that referenced this pull request Jul 31, 2024
Basically, workflow telemetry uses step names for gantt charts which
uses Github's native support for mermaidjs for rendering the charts in
issues and PRs. However mermaidjs has an issue
(mermaid-js/mermaid#2495) when you use
mermaid reserved keywords in node names/text.

To fix rendering of the ipsec upgrade workflow's telemetry, avoid the
use of the "call" keyword.

This is a work around for catchpoint/workflow-telemetry-action#76.
If an when catchpoint/workflow-telemetry-action#77 is merged, we do not need to be concerned with workflow step names.

Fixes #32241

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
nbusseneau pushed a commit to cilium/cilium that referenced this pull request Aug 3, 2024
[ upstream commit 9592c69 ]

Basically, workflow telemetry uses step names for gantt charts which
uses Github's native support for mermaidjs for rendering the charts in
issues and PRs. However mermaidjs has an issue
(mermaid-js/mermaid#2495) when you use
mermaid reserved keywords in node names/text.

To fix rendering of the ipsec upgrade workflow's telemetry, avoid the
use of the "call" keyword.

This is a work around for catchpoint/workflow-telemetry-action#76.
If an when catchpoint/workflow-telemetry-action#77 is merged, we do not need to be concerned with workflow step names.

Fixes #32241

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
nbusseneau pushed a commit to cilium/cilium that referenced this pull request Aug 3, 2024
[ upstream commit 9592c69 ]

Basically, workflow telemetry uses step names for gantt charts which
uses Github's native support for mermaidjs for rendering the charts in
issues and PRs. However mermaidjs has an issue
(mermaid-js/mermaid#2495) when you use
mermaid reserved keywords in node names/text.

To fix rendering of the ipsec upgrade workflow's telemetry, avoid the
use of the "call" keyword.

This is a work around for catchpoint/workflow-telemetry-action#76.
If an when catchpoint/workflow-telemetry-action#77 is merged, we do not need to be concerned with workflow step names.

Fixes #32241

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
gandro pushed a commit to cilium/cilium that referenced this pull request Aug 6, 2024
[ upstream commit 9592c69 ]

Basically, workflow telemetry uses step names for gantt charts which
uses Github's native support for mermaidjs for rendering the charts in
issues and PRs. However mermaidjs has an issue
(mermaid-js/mermaid#2495) when you use
mermaid reserved keywords in node names/text.

To fix rendering of the ipsec upgrade workflow's telemetry, avoid the
use of the "call" keyword.

This is a work around for catchpoint/workflow-telemetry-action#76.
If an when catchpoint/workflow-telemetry-action#77 is merged, we do not need to be concerned with workflow step names.

Fixes #32241

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to render rich display when generated telemetry contains mermaid keywords
1 participant