From 810edfa2935a36d76381811f3844d509dacf6e61 Mon Sep 17 00:00:00 2001
From: A1lo <yin199909@aliyun.com>
Date: Thu, 20 Jul 2023 21:45:59 +0800
Subject: [PATCH] fix(deployer): escape markdown markup in link text (#8996)

---
 deployer/src/deployer/analyze_pr.py      | 2 +-
 deployer/src/deployer/test_analyze_pr.py | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/deployer/src/deployer/analyze_pr.py b/deployer/src/deployer/analyze_pr.py
index ee8c96541a90..f1e3ddcf20de 100644
--- a/deployer/src/deployer/analyze_pr.py
+++ b/deployer/src/deployer/analyze_pr.py
@@ -90,7 +90,7 @@ def post_about_deployment(build_directory: Path, **config):
     for doc in get_built_docs(build_directory):
         url = mdn_url_to_dev_url(config["prefix"], doc["mdn_url"])
         mdn_url = doc["mdn_url"]
-        links.append(f"- [{mdn_url}]({url})")
+        links.append(f"- [`{mdn_url}`]({url})")
     links.sort()
 
     if links:
diff --git a/deployer/src/deployer/test_analyze_pr.py b/deployer/src/deployer/test_analyze_pr.py
index c006182b6663..fe3e65dc17e0 100644
--- a/deployer/src/deployer/test_analyze_pr.py
+++ b/deployer/src/deployer/test_analyze_pr.py
@@ -39,7 +39,7 @@ def test_analyze_pr_prefix():
         comment = analyze_pr(build_directory, dict(DEFAULT_CONFIG, prefix="pr007"))
         assert "<b>Preview URLs</b>" in comment
         assert (
-            "- [/en-US/docs/Foo](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo)"
+            "- [`/en-US/docs/Foo`](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo)"
             in comment
         )
 
@@ -55,7 +55,7 @@ def test_analyze_pr_preview_urls():
         comment = analyze_pr(build_directory, dict(DEFAULT_CONFIG, prefix="pr007"))
         assert "<details><summary><b>Preview URLs</b> (6 pages)</summary>" in comment
         assert (
-            "- [/en-US/docs/Foo6](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo6)\n\n</details>"
+            "- [`/en-US/docs/Foo6`](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo6)\n\n</details>"
             in comment
         )
 
@@ -207,7 +207,7 @@ def test_analyze_pr_prefix_and_postcomment(mocked_github):
         )
         assert "<b>Preview URLs</b>" in comment
         assert (
-            "- [/en-US/docs/Foo](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo)"
+            "- [`/en-US/docs/Foo`](https://pr007.content.dev.mdn.mozit.cloud/en-US/docs/Foo)"
             in comment
         )