Skip to content

Conversation

@jakobbotsch
Copy link
Member

@jakobbotsch jakobbotsch commented Jun 21, 2023

The summarize script will convert markdown diff code blocks into manually colored HTML tags because AzDO does not support proper highlighting in its preview. However, when we do this we should also take care to escape the contents as otherwise it can start being interpreted as HTML tags. For example, in a recent case a field named <Option>k__BackingField caused the preview to be truncated because was interpreted as a HTML tag.

The summarize script will convert markdown diff code blocks into
manually colored HTML tags because AzDO does not support proper
highlighting in its preview. However, when we do this we should also
take care to escape the contents as otherwise it can start being
interpreted as HTML tags. For example, in a recent case a field named
"<Option>k__BackingField" caused the preview to be truncated because
<option> was interpreted as a HTML tag.
@ghost ghost added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Jun 21, 2023
@ghost ghost assigned jakobbotsch Jun 21, 2023
@ghost
Copy link

ghost commented Jun 21, 2023

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

Issue Details

The summarize script will convert markdown diff code blocks into manually colored HTML tags because AzDO does not support proper highlighting in its preview. However, when we do this we should also take care to escape the contents as otherwise it can start being interpreted as HTML tags. For example, in a recent case a field named "k__BackingField" caused the preview to be truncated because was interpreted as a HTML tag.

Author: jakobbotsch
Assignees: jakobbotsch
Labels:

area-CodeGen-coreclr

Milestone: -

@jakobbotsch
Copy link
Member Author

Before:
image

After:
image

@jakobbotsch
Copy link
Member Author

cc @dotnet/jit-contrib PTAL @EgorBo

@jakobbotsch jakobbotsch requested a review from EgorBo June 21, 2023 08:24
@jakobbotsch jakobbotsch merged commit 4d4bc3f into dotnet:main Jun 21, 2023
@jakobbotsch jakobbotsch deleted the html-escape-diff branch June 21, 2023 10:30
@ghost ghost locked as resolved and limited conversation to collaborators Jul 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants