121 lines
4.3 KiB
PowerShell
121 lines
4.3 KiB
PowerShell
# Note, due to how `Expand-Archive` is leveraged in this script,
|
|
# powershell core is a requirement for successful execution.
|
|
param (
|
|
# arguments leveraged to parse and identify artifacts
|
|
$ArtifactLocation, # the root of the artifact folder. DevOps $(System.ArtifactsDirectory)
|
|
$WorkDirectory, # a clean folder that we can work in
|
|
$ReleaseSHA, # the SHA for the artifacts. DevOps: $(Release.Artifacts.<artifactAlias>.SourceVersion) or $(Build.SourceVersion)
|
|
$RepoId, # full repo id. EG azure/azure-sdk-for-net DevOps: $(Build.Repository.Id). Used as a part of VerifyPackages
|
|
$Repository, # EG: "Maven", "PyPI", "NPM"
|
|
|
|
# arguments necessary to power the docs release
|
|
$DocRepoLocation, # the location on disk where we have cloned the documentation repository
|
|
$Language, # EG: js, java, dotnet. Used in language for the embedded readme.
|
|
$DocRepoContentLocation = "docs-ref-services/" # within the doc repo, where does our readme go?
|
|
)
|
|
|
|
. (Join-Path $PSScriptRoot common.ps1)
|
|
|
|
$releaseReplaceRegex = "(https://github.com/$RepoId/(?:blob|tree)/)master"
|
|
|
|
function GetMetaData {
|
|
if (Test-Path Variable:MetadataUri) {
|
|
$metadataResponse = Invoke-RestMethod -Uri $MetadataUri -method "GET" -MaximumRetryCount 3 -RetryIntervalSec 10 | ConvertFrom-Csv
|
|
}
|
|
else {
|
|
LogError "The variable '$MetadataUri' was not found."
|
|
}
|
|
|
|
return $metadataResponse
|
|
}
|
|
|
|
function GetAdjustedReadmeContent($pkgInfo){
|
|
$date = Get-Date -Format "MM/dd/yyyy"
|
|
$service = ""
|
|
|
|
# the namespace is not expected to be present for js.
|
|
$pkgId = $pkgInfo.PackageId.Replace("@azure/", "")
|
|
|
|
try {
|
|
$metadata = GetMetaData
|
|
|
|
$service = $metadata | ? { $_.Package -eq $pkgId }
|
|
|
|
if ($service) {
|
|
$service = "$($service.ServiceName)".ToLower().Replace(" ", "")
|
|
}
|
|
}
|
|
catch {
|
|
Write-Host $_
|
|
Write-Host "Unable to retrieve service metadata for packageId $($pkgInfo.PackageId)"
|
|
}
|
|
|
|
$fileContent = $pkgInfo.ReadmeContent
|
|
|
|
# only replace the version if the formatted header can be found
|
|
$titleRegex = "(\#\s+(?<filetitle>Azure .+? (?:client|plugin|shared) library for (?:JavaScript|Java|Python|\.NET|C)))"
|
|
$foundTitle = ""
|
|
if ($fileContent -match $titleRegex) {
|
|
$fileContent = $fileContent -replace $titleRegex, "`${0} - Version $($pkgInfo.PackageVersion) `n"
|
|
$foundTitle = $matches["filetitle"]
|
|
}
|
|
# Replace github master link with release tag.
|
|
$ReplacementPattern = "`${1}$($pkgInfo.Tag)"
|
|
$fileContent = $fileContent -replace $releaseReplaceRegex, $ReplacementPattern
|
|
|
|
$header = "---`ntitle: $foundTitle`nkeywords: Azure, $Language, SDK, API, $($pkgInfo.PackageId), $service`nauthor: maggiepint`nms.author: magpint`nms.date: $date`nms.topic: article`nms.prod: azure`nms.technology: azure`nms.devlang: $Language`nms.service: $service`n---`n"
|
|
|
|
if ($fileContent) {
|
|
return "$header`n$fileContent"
|
|
}
|
|
else {
|
|
return ""
|
|
}
|
|
}
|
|
|
|
$apiUrl = "https://api.github.com/repos/$repoId"
|
|
$pkgs = VerifyPackages -artifactLocation $ArtifactLocation `
|
|
-workingDirectory $WorkDirectory `
|
|
-apiUrl $apiUrl `
|
|
-releaseSha $ReleaseSHA `
|
|
-continueOnError $True
|
|
|
|
if ($pkgs) {
|
|
Write-Host "Given the visible artifacts, readmes will be copied for the following packages"
|
|
Write-Host ($pkgs | % { $_.PackageId })
|
|
|
|
foreach ($packageInfo in $pkgs) {
|
|
# sync the doc repo
|
|
$semVer = [AzureEngSemanticVersion]::ParseVersionString($packageInfo.PackageVersion)
|
|
$rdSuffix = ""
|
|
if ($semVer.IsPreRelease) {
|
|
$rdSuffix = "-pre"
|
|
}
|
|
|
|
$readmeName = "$($packageInfo.PackageId.Replace('azure-','').Replace('Azure.', '').Replace('@azure/', '').ToLower())-readme$rdSuffix.md"
|
|
$readmeLocation = Join-Path $DocRepoLocation $DocRepoContentLocation $readmeName
|
|
|
|
if ($packageInfo.ReadmeContent) {
|
|
$adjustedContent = GetAdjustedReadmeContent -pkgInfo $packageInfo
|
|
}
|
|
|
|
if ($adjustedContent) {
|
|
try {
|
|
Push-Location $DocRepoLocation
|
|
Set-Content -Path $readmeLocation -Value $adjustedContent -Force
|
|
|
|
Write-Host "Updated readme for $readmeName."
|
|
} catch {
|
|
Write-Host $_
|
|
} finally {
|
|
Pop-Location
|
|
}
|
|
} else {
|
|
Write-Host "Unable to parse a header out of the readmecontent for PackageId $($packageInfo.PackageId)"
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
Write-Host "No readmes discovered for doc release under folder $ArtifactLocation."
|
|
}
|