Skip to content

Commit 72ed8a2

Browse files
azure-sdkhallipr
andauthored
Sync eng/common directory with azure-sdk-tools for PR 3169 (Azure#24115)
* Use the batch version of ValidateDocsMsPackagesFn * Use proper pipelining for GetPackageInfoJson function Co-authored-by: Patrick Hallisey <[email protected]>
1 parent e443b94 commit 72ed8a2

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

eng/common/scripts/Update-DocsMsMetadata.ps1

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ function GetPackageInfoJson ($packageInfoJsonLocation) {
153153
# version is always 'dev' when interacting with NPM.
154154
if ($GetDocsMsDevLanguageSpecificPackageInfoFn -and (Test-Path "Function:$GetDocsMsDevLanguageSpecificPackageInfoFn")) {
155155
$packageInfo = &$GetDocsMsDevLanguageSpecificPackageInfoFn $packageInfo
156-
} else {
156+
}
157+
else {
157158
# Default: use the dev version from package info as the version for
158159
# downstream processes
159160
$packageInfo.Version = $packageInfo.DevVersion
@@ -162,19 +163,23 @@ function GetPackageInfoJson ($packageInfoJsonLocation) {
162163
return $packageInfo
163164
}
164165

165-
function UpdateDocsMsMetadataForPackage($packageInfoJsonLocation, $packageInfo) {
166+
function UpdateDocsMsMetadataForPackage($packageInfoJsonLocation) {
167+
$packageInfo = GetPackageInfoJson $packageInfoJsonLocation
168+
166169
$originalVersion = [AzureEngSemanticVersion]::ParseVersionString($packageInfo.Version)
167170
$packageMetadataArray = (Get-CSVMetadata).Where({ $_.Package -eq $packageInfo.Name -and $_.Hide -ne 'true' -and $_.New -eq 'true' })
168171
if ($packageInfo.Group) {
169-
$packageMetadataArray = ($packageMetadataArray).Where({$_.GroupId -eq $packageInfo.Group})
172+
$packageMetadataArray = ($packageMetadataArray).Where({ $_.GroupId -eq $packageInfo.Group })
170173
}
171174
if ($packageMetadataArray.Count -eq 0) {
172175
LogWarning "Could not retrieve metadata for $($packageInfo.Name) from metadata CSV. Using best effort defaults."
173176
$packageMetadata = $null
174-
} elseif ($packageMetadataArray.Count -gt 1) {
177+
}
178+
elseif ($packageMetadataArray.Count -gt 1) {
175179
LogWarning "Multiple metadata entries for $($packageInfo.Name) in metadata CSV. Using first entry."
176180
$packageMetadata = $packageMetadataArray[0]
177-
} else {
181+
}
182+
else {
178183
$packageMetadata = $packageMetadataArray[0]
179184
}
180185

@@ -214,15 +219,17 @@ function UpdateDocsMsMetadataForPackage($packageInfoJsonLocation, $packageInfo)
214219
Set-Content -Path $readmeLocation -Value $outputReadmeContent
215220
}
216221

222+
# For daily update and release, validate DocsMS publishing using the language-specific validation function
223+
if ($ValidateDocsMsPackagesFn -and (Test-Path "Function:$ValidateDocsMsPackagesFn")) {
224+
Write-Host "Validating the packages..."
225+
226+
$packageInfos = @($PackageInfoJsonLocations | ForEach-Object { GetPackageInfoJson $_ })
227+
228+
&$ValidateDocsMsPackagesFn -PackageInfos $packageInfos -PackageSourceOverride $PackageSourceOverride -DocValidationImageId $DocValidationImageId -DocRepoLocation $DocRepoLocation
229+
}
230+
217231
foreach ($packageInfoLocation in $PackageInfoJsonLocations) {
218232
Write-Host "Updating metadata for package: $packageInfoLocation"
219233
# Convert package metadata json file to metadata json property.
220-
$packageInfo = GetPackageInfoJson $packageInfoLocation
221-
# Add validation step for daily update and release
222-
if ($ValidateDocsMsPackagesFn -and (Test-Path "Function:$ValidateDocsMsPackagesFn")) {
223-
Write-Host "Validating the package..."
224-
&$ValidateDocsMsPackagesFn -PackageInfo $packageInfo -PackageSourceOverride $PackageSourceOverride -DocValidationImageId $DocValidationImageId -DocRepoLocation $DocRepoLocation
225-
}
226-
Write-Host "Updating the package json ..."
227-
UpdateDocsMsMetadataForPackage $packageInfoLocation $packageInfo
234+
UpdateDocsMsMetadataForPackage $packageInfoLocation
228235
}

0 commit comments

Comments
 (0)