Skip to content

Commit dad28f1

Browse files
Sync eng/common directory with azure-sdk-tools for PR 9177 (Azure#46670)
* Escape parentheses in includes to fix issues in publishing * Only escape close parens * Comments --------- Co-authored-by: Daniel Jurek <[email protected]>
1 parent 4a4a28c commit dad28f1

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

eng/common/scripts/Helpers/Service-Level-Readme-Automation-Helpers.ps1

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,17 @@ function create-service-readme(
1111
$readmePath = Join-Path $readmeFolder -ChildPath $readmeName
1212
$content = ""
1313
if (Test-Path (Join-Path $readmeFolder -ChildPath $indexTableLink)) {
14+
# Escape the close parentheses in the URL. This is required by docs
15+
# https://github.com/Azure/azure-sdk-tools/issues/5433
16+
# This line looks incorrect but the left parameter is a regex and must
17+
# escape the parentheses. The right is a literal string and, since this is
18+
# PowerShell, the backslash does not itself need to be escaped.
19+
20+
# Example: "filename-with-(parens).md" -> "filename-with-(parens\).md"
21+
$escapedIndexTableLink = $indexTableLink -replace '\)', '\)'
22+
1423
$content = "## Packages - $moniker`r`n"
15-
$content += "[!INCLUDE [packages]($indexTableLink)]"
24+
$content += "[!INCLUDE [packages]($escapedIndexTableLink)]"
1625
}
1726
if (!$content) {
1827
LogError "There are no packages under service '$serviceName'. "
@@ -101,15 +110,15 @@ function generate-service-level-readme(
101110
$readmeFolder = "$docRepoLocation/$pathPrefix/$moniker/"
102111
$serviceReadme = "$readmeBaseName.md"
103112
$indexReadme = "$readmeBaseName-index.md"
104-
113+
105114
if ($packageInfos) {
106115
generate-markdown-table `
107116
-readmeFolder $readmeFolder `
108117
-readmeName $indexReadme `
109118
-packageInfos $packageInfos `
110-
-moniker $moniker
119+
-moniker $moniker
111120
}
112-
121+
113122
if (!(Test-Path "$readmeFolder$serviceReadme") -and $packageInfos) {
114123
create-service-readme `
115124
-readmeFolder $readmeFolder `

0 commit comments

Comments
 (0)