From 546e0996f262ca22f1f221343f0de83a55261c36 Mon Sep 17 00:00:00 2001
From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Date: Thu, 17 Oct 2024 08:53:08 -0700
Subject: [PATCH] Sync eng/common directory with azure-sdk-tools for PR 9177
 (#23591)

* Escape parentheses in includes to fix issues in publishing

* Only escape close parens

* Comments

---------

Co-authored-by: Daniel Jurek <djurek@microsoft.com>
---
 .../Service-Level-Readme-Automation-Helpers.ps1 | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/eng/common/scripts/Helpers/Service-Level-Readme-Automation-Helpers.ps1 b/eng/common/scripts/Helpers/Service-Level-Readme-Automation-Helpers.ps1
index 4382b6159f17..2b3b592a41d7 100644
--- a/eng/common/scripts/Helpers/Service-Level-Readme-Automation-Helpers.ps1
+++ b/eng/common/scripts/Helpers/Service-Level-Readme-Automation-Helpers.ps1
@@ -11,8 +11,17 @@ function create-service-readme(
   $readmePath = Join-Path $readmeFolder -ChildPath $readmeName
   $content = ""
   if (Test-Path (Join-Path $readmeFolder -ChildPath $indexTableLink)) {
+    # Escape the close parentheses in the URL. This is required by docs
+    # https://github.com/Azure/azure-sdk-tools/issues/5433
+    # This line looks incorrect but the left parameter is a regex and must
+    # escape the parentheses. The right is a literal string and, since this is
+    # PowerShell, the backslash does not itself need to be escaped.
+
+    # Example: "filename-with-(parens).md" -> "filename-with-(parens\).md"
+    $escapedIndexTableLink = $indexTableLink -replace '\)', '\)'
+
     $content = "## Packages - $moniker`r`n"
-    $content += "[!INCLUDE [packages]($indexTableLink)]"
+    $content += "[!INCLUDE [packages]($escapedIndexTableLink)]"
   }
   if (!$content) {
     LogError "There are no packages under service '$serviceName'. "
@@ -101,15 +110,15 @@ function generate-service-level-readme(
   $readmeFolder = "$docRepoLocation/$pathPrefix/$moniker/"
   $serviceReadme = "$readmeBaseName.md"
   $indexReadme  = "$readmeBaseName-index.md"
- 
+
   if ($packageInfos) {
     generate-markdown-table `
       -readmeFolder $readmeFolder `
       -readmeName $indexReadme `
       -packageInfos $packageInfos `
-      -moniker $moniker  
+      -moniker $moniker
   }
-  
+
   if (!(Test-Path "$readmeFolder$serviceReadme") -and $packageInfos) {
     create-service-readme `
       -readmeFolder $readmeFolder `