From 2dc4b5869c9cd20030c54e150e7b14cef0eaefd3 Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Thu, 28 Jan 2021 10:36:09 -0800 Subject: [PATCH 1/4] Use a helper function to normalize the package name for readme --- eng/common/scripts/common.ps1 | 3 ++- eng/common/scripts/update-docs-metadata.ps1 | 11 ++++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/eng/common/scripts/common.ps1 b/eng/common/scripts/common.ps1 index 8ccf27b0ba4..613c524bd6f 100644 --- a/eng/common/scripts/common.ps1 +++ b/eng/common/scripts/common.ps1 @@ -41,4 +41,5 @@ $GetPackageInfoFromPackageFileFn = "Get-${Language}-PackageInfoFromPackageFile" $PublishGithubIODocsFn = "Publish-${Language}-GithubIODocs" $UpdateDocCIFn = "Update-${Language}-CIConfig" $GetGithubIoDocIndexFn = "Get-${Language}-GithubIoDocIndex" -$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" \ No newline at end of file +$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" +$NormalizePackageNameFn = "Normalize-${Language}-Package-name" \ No newline at end of file diff --git a/eng/common/scripts/update-docs-metadata.ps1 b/eng/common/scripts/update-docs-metadata.ps1 index 0961f5ec6a0..7db23b3f325 100644 --- a/eng/common/scripts/update-docs-metadata.ps1 +++ b/eng/common/scripts/update-docs-metadata.ps1 @@ -103,7 +103,16 @@ foreach ($config in $targets) { Write-Host ($pkgsFiltered | % { $_.PackageId + " " + $_.PackageVersion }) foreach ($packageInfo in $pkgsFiltered) { - $readmeName = "$($packageInfo.PackageId.Replace('azure-','').Replace('Azure.', '').Replace('@azure/', '').ToLower())-readme${suffix}.md" + $readmeName = "" + if ($NormalizePackageNameFn -and (Test-Path "function:$NormalizePackageNameFn")) + { + $readmeName = "$(&$NormalizePackageNameFn -packageId $packageInfo.PackageId).ToLower())-readme${suffix}.md" + } + else + { + $readmeName = "$($packageInfo.PackageId).ToLower())-readme${suffix}.md" + } + $readmeFolder = Join-Path $DocRepoLocation $config.content_folder $readmeLocation = Join-Path $readmeFolder $readmeName From bca3363c45c324973fe6cd13c446e4f55a28a5fe Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Mon, 1 Feb 2021 14:34:16 -0800 Subject: [PATCH 2/4] Get the readme name from artifact-metadata-parsing --- eng/common/scripts/artifact-metadata-parsing.ps1 | 9 ++++++++- eng/common/scripts/common.ps1 | 3 +-- eng/common/scripts/update-docs-metadata.ps1 | 11 +---------- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/eng/common/scripts/artifact-metadata-parsing.ps1 b/eng/common/scripts/artifact-metadata-parsing.ps1 index 82be9b69ac8..6d1a88e4621 100644 --- a/eng/common/scripts/artifact-metadata-parsing.ps1 +++ b/eng/common/scripts/artifact-metadata-parsing.ps1 @@ -123,7 +123,13 @@ function VerifyPackages($artifactLocation, $workingDirectory, $apiUrl, $releaseS Write-Host "Maybe a pkg version wasn't updated properly?" exit(1) } - + $docsReadMeName = "" + if ($parsedPackage.DocsReadMeName) { + $docsReadMeName = $parsedPackage.DocsReadMeName + } + else { + $docsReadMeName = $parsedPackage.PackageId + } $pkgList += New-Object PSObject -Property @{ PackageId = $parsedPackage.PackageId PackageVersion = $parsedPackage.PackageVersion @@ -131,6 +137,7 @@ function VerifyPackages($artifactLocation, $workingDirectory, $apiUrl, $releaseS Tag = $parsedPackage.ReleaseTag ReleaseNotes = $parsedPackage.ReleaseNotes ReadmeContent = $parsedPackage.ReadmeContent + DocsReadMeName = $docsReadMeName IsPrerelease = [AzureEngSemanticVersion]::ParseVersionString($parsedPackage.PackageVersion).IsPrerelease } } diff --git a/eng/common/scripts/common.ps1 b/eng/common/scripts/common.ps1 index 613c524bd6f..8ccf27b0ba4 100644 --- a/eng/common/scripts/common.ps1 +++ b/eng/common/scripts/common.ps1 @@ -41,5 +41,4 @@ $GetPackageInfoFromPackageFileFn = "Get-${Language}-PackageInfoFromPackageFile" $PublishGithubIODocsFn = "Publish-${Language}-GithubIODocs" $UpdateDocCIFn = "Update-${Language}-CIConfig" $GetGithubIoDocIndexFn = "Get-${Language}-GithubIoDocIndex" -$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" -$NormalizePackageNameFn = "Normalize-${Language}-Package-name" \ No newline at end of file +$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" \ No newline at end of file diff --git a/eng/common/scripts/update-docs-metadata.ps1 b/eng/common/scripts/update-docs-metadata.ps1 index 7db23b3f325..eacc56bbecd 100644 --- a/eng/common/scripts/update-docs-metadata.ps1 +++ b/eng/common/scripts/update-docs-metadata.ps1 @@ -103,16 +103,7 @@ foreach ($config in $targets) { Write-Host ($pkgsFiltered | % { $_.PackageId + " " + $_.PackageVersion }) foreach ($packageInfo in $pkgsFiltered) { - $readmeName = "" - if ($NormalizePackageNameFn -and (Test-Path "function:$NormalizePackageNameFn")) - { - $readmeName = "$(&$NormalizePackageNameFn -packageId $packageInfo.PackageId).ToLower())-readme${suffix}.md" - } - else - { - $readmeName = "$($packageInfo.PackageId).ToLower())-readme${suffix}.md" - } - + $readmeName = $packageInfo.DocsReadMeName $readmeFolder = Join-Path $DocRepoLocation $config.content_folder $readmeLocation = Join-Path $readmeFolder $readmeName From 901bb60a03b6901711f004b5999d447136486e30 Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Mon, 1 Feb 2021 16:14:59 -0800 Subject: [PATCH 3/4] Change to the readme --- eng/common/scripts/update-docs-metadata.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/common/scripts/update-docs-metadata.ps1 b/eng/common/scripts/update-docs-metadata.ps1 index eacc56bbecd..fc16fea9e55 100644 --- a/eng/common/scripts/update-docs-metadata.ps1 +++ b/eng/common/scripts/update-docs-metadata.ps1 @@ -103,7 +103,7 @@ foreach ($config in $targets) { Write-Host ($pkgsFiltered | % { $_.PackageId + " " + $_.PackageVersion }) foreach ($packageInfo in $pkgsFiltered) { - $readmeName = $packageInfo.DocsReadMeName + $readmeName = "$($packageInfo.DocsReadMeName.ToLower())-readme${suffix}.md" $readmeFolder = Join-Path $DocRepoLocation $config.content_folder $readmeLocation = Join-Path $readmeFolder $readmeName From 12e06985893c33a15e3c998b326d0ccf860c2d87 Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Mon, 1 Feb 2021 17:19:06 -0800 Subject: [PATCH 4/4] Update eng/common/scripts/artifact-metadata-parsing.ps1 Co-authored-by: Wes Haggard --- eng/common/scripts/artifact-metadata-parsing.ps1 | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/eng/common/scripts/artifact-metadata-parsing.ps1 b/eng/common/scripts/artifact-metadata-parsing.ps1 index 6d1a88e4621..2339155b359 100644 --- a/eng/common/scripts/artifact-metadata-parsing.ps1 +++ b/eng/common/scripts/artifact-metadata-parsing.ps1 @@ -123,13 +123,10 @@ function VerifyPackages($artifactLocation, $workingDirectory, $apiUrl, $releaseS Write-Host "Maybe a pkg version wasn't updated properly?" exit(1) } - $docsReadMeName = "" + $docsReadMeName = $parsedPackage.PackageId if ($parsedPackage.DocsReadMeName) { $docsReadMeName = $parsedPackage.DocsReadMeName } - else { - $docsReadMeName = $parsedPackage.PackageId - } $pkgList += New-Object PSObject -Property @{ PackageId = $parsedPackage.PackageId PackageVersion = $parsedPackage.PackageVersion