Skip to content

Fix system note difference highlighting

What does this MR do and why?

When rendering a changed title system note, it attempts to render those titles with our markdown pipeline. However this can cause a variety of strange situations. For example, if the title is

#55 title change and lots more

and it's changed to

#55 title change _and_ x^2 lots more

Screenshot_2025-04-04_at_4.33.26_PM

Solution is to force it into a code block and not render the markdown. Description differences are also shown as code.

The use of <div> keeps markdown from parsing its contents. Using <code> keeps our various filters (like references and SpacedLinkFilter) from detecting anything.

References

Screenshots or screen recordings

Before After
Screenshot_2025-04-04_at_4.33.26_PM Screenshot_2025-04-07_at_1.31.51_PM

How to set up and validate locally

  1. Create issue with the title #55 title change and lots more

  2. Change the title to #55 title change _and_ x^2 lots more. A system note should be added that looks like this

    Screenshot_2025-04-07_at_1.31.51_PM

  3. Change the title to #55 titles change and x^2 lots more. A system note should be added that looks like this

    Screenshot_2025-04-07_at_1.32.01_PM

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #15349 (closed)

Edited by Brett Walker

Merge request reports

Loading