Skip to content

Commit b0e952a

Browse files
azure-sdkpraveenkuttappanweshaggard
authored
Sync eng/common directory with azure-sdk-tools for PR 4628 (Azure#19555)
* Add new check in APIView to verify and enforce package name approval * Changes as per review feedback * Apply suggestions from code review Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com> Co-authored-by: praveenkuttappan <praveen.kuttappan@gmail.com> Co-authored-by: Praven Kuttappan <55455725+praveenkuttappan@users.noreply.github.com> Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
1 parent 08f682e commit b0e952a

File tree

3 files changed

+31
-17
lines changed

3 files changed

+31
-17
lines changed

eng/common/scripts/Create-APIReview.ps1

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,13 @@ if ($packages)
130130
}
131131
elseif ($version.IsPrerelease)
132132
{
133+
# Check if package name is approved. Preview version cannot be released without package name approval
134+
if ($respCode -eq '202' -and $pkgInfo.ReleaseStatus -and $pkgInfo.ReleaseStatus -ne "Unreleased")
135+
{
136+
Write-Host "Package name is not yet approved on APIView for $($PackageName). Package name must be approved by an API approver for a beta release if it was never released a stable version."
137+
Write-Host "You can check http://aka.ms/azsdk/engsys/apireview/faq for more details on package name approval."
138+
exit 1
139+
}
133140
# Ignore API review status for prerelease version
134141
Write-Host "Package version is not GA. Ignoring API view approval status"
135142
}

eng/common/scripts/Helpers/ApiView-Helpers.ps1

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,19 @@ function Check-ApiReviewStatus($packageName, $packageVersion, $language, $url, $
4242
{
4343
Write-Host "API Review is approved for package $($packageName)"
4444
}
45+
else if ($response.StatusCode -eq '202')
46+
{
47+
Write-Host "Package name $($packageName) is not yet approved by an SDK API approver. Package name must be approved to release a beta version if $($packageName) was never released a stable version."
48+
Write-Host "You can check http://aka.ms/azsdk/engsys/apireview/faq for more details on package name Approval."
49+
}
50+
else if ($response.StatusCode -eq '201')
51+
{
52+
Write-Warning "API Review is not approved for package $($packageName). Release pipeline will fail if API review is not approved for a stable version release."
53+
Write-Host "You can check http://aka.ms/azsdk/engsys/apireview/faq for more details on API Approval."
54+
}
4555
else
4656
{
47-
Write-Warning "API Review is not approved for package $($packageName). Release pipeline will fail if API review is not approved."
57+
Write-Warning "API review status check returned unexpected response. $($response)"
4858
Write-Host "You can check http://aka.ms/azsdk/engsys/apireview/faq for more details on API Approval."
4959
}
5060
}

eng/common/scripts/Prepare-Release.ps1

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -152,24 +152,21 @@ if ($LASTEXITCODE -ne 0) {
152152
exit 1
153153
}
154154

155-
# Check API status if version is GA
156-
if (!$newVersionParsed.IsPrerelease)
155+
# Check API status
156+
try
157157
{
158-
try
159-
{
160-
az account show *> $null
161-
if (!$?) {
162-
Write-Host 'Running az login...'
163-
az login *> $null
164-
}
165-
$url = az keyvault secret show --name "APIURL" --vault-name "AzureSDKPrepRelease-KV" --query "value" --output "tsv"
166-
$apiKey = az keyvault secret show --name "APIKEY" --vault-name "AzureSDKPrepRelease-KV" --query "value" --output "tsv"
167-
Check-ApiReviewStatus -PackageName $packageProperties.Name -packageVersion $newVersion -Language $LanguageDisplayName -url $url -apiKey $apiKey
168-
}
169-
catch
170-
{
171-
Write-Warning "Failed to get APIView URL and API Key from Keyvault AzureSDKPrepRelease-KV. Please check and ensure you have access to this Keyvault as reader."
158+
az account show *> $null
159+
if (!$?) {
160+
Write-Host 'Running az login...'
161+
az login *> $null
172162
}
163+
$url = az keyvault secret show --name "APIURL" --vault-name "AzureSDKPrepRelease-KV" --query "value" --output "tsv"
164+
$apiKey = az keyvault secret show --name "APIKEY" --vault-name "AzureSDKPrepRelease-KV" --query "value" --output "tsv"
165+
Check-ApiReviewStatus -PackageName $packageProperties.Name -packageVersion $newVersion -Language $LanguageDisplayName -url $url -apiKey $apiKey
166+
}
167+
catch
168+
{
169+
Write-Warning "Failed to get APIView URL and API Key from Keyvault AzureSDKPrepRelease-KV. Please check and ensure you have access to this Keyvault as reader."
173170
}
174171

175172
if ($releaseTrackingOnly)

0 commit comments

Comments
 (0)