github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update apiview scripts to support sdk automation (#6431)

Browse Source 
Co-authored-by: Chidozie Ononiwu <chononiw@microsoft.com>
This commit is contained in:
Azure SDK Bot 2025-02-21 17:26:12 -08:00 committed by GitHub
parent 97182996eb
commit 97463f30d2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
eng/common/pipelines/templates/steps/detect-api-changes.yml
View File

@ -1,6 +1,7 @@
parameters:
ArtifactPath: $(Build.ArtifactStagingDirectory)
ArtifactName: 'packages'
RepoRoot: $(Build.SourcesDirectory)
steps:
- pwsh: |
@ -11,7 +12,7 @@ steps:
- task: Powershell@2
inputs:
filePath: $(Build.SourcesDirectory)/eng/common/scripts/Detect-Api-Changes.ps1
filePath: ${{ parameters.RepoRoot }}/eng/common/scripts/Detect-Api-Changes.ps1
arguments: >
-ArtifactPath ${{parameters.ArtifactPath}}
-CommitSha '$(Build.SourceVersion)'

40
eng/common/scripts/Detect-Api-Changes.ps1
View File

@ -46,7 +46,7 @@ function Submit-Request($filePath, $packageName)
}
$uri = [System.UriBuilder]$APIViewUri
$uri.query = $query.toString()
Write-Host "Request URI: $($uri.Uri.OriginalString)"
LogInfo "Request URI: $($uri.Uri.OriginalString)"
try
{
$Response = Invoke-WebRequest -Method 'GET' -Uri $uri.Uri -MaximumRetryCount 3
@ -54,7 +54,7 @@ function Submit-Request($filePath, $packageName)
}
catch
{
Write-Host "Error $StatusCode - Exception details: $($_.Exception.Response)"
LogError "Error $StatusCode - Exception details: $($_.Exception.Response)"
$StatusCode = $_.Exception.Response.StatusCode
}
@ -67,7 +67,7 @@ function Should-Process-Package($pkgPath, $packageName)
$pkgPropPath = Join-Path -Path $configFileDir "$packageName.json"
if (!(Test-Path $pkgPropPath))
{
Write-Host " Package property file path $($pkgPropPath) is invalid."
LogWarning "Package property file path $($pkgPropPath) is invalid."
return $False
}
# Get package info from json file created before updating version to daily dev
@ -75,27 +75,29 @@ function Should-Process-Package($pkgPath, $packageName)
$packagePath = $pkgInfo.DirectoryPath
$modifiedFiles = @(Get-ChangedFiles -DiffPath "$packagePath/*" -DiffFilterType '')
$filteredFileCount = $modifiedFiles.Count
Write-Host "Number of modified files for package: $filteredFileCount"
LogInfo "Number of modified files for package: $filteredFileCount"
return ($filteredFileCount -gt 0 -and $pkgInfo.IsNewSdk)
}
function Log-Input-Params()
{
Write-Host "Artifact Path: $($ArtifactPath)"
Write-Host "Artifact Name: $($ArtifactName)"
Write-Host "PullRequest Number: $($PullRequestNumber)"
Write-Host "BuildId: $($BuildId)"
Write-Host "Language: $($Language)"
Write-Host "Commit SHA: $($CommitSha)"
Write-Host "Repo Name: $($RepoFullName)"
Write-Host "Project: $($DevopsProject)"
LogGroupStart "Input Parameters for $($ArtifactName)"
LogInfo "Artifact Path: $($ArtifactPath)"
LogInfo "Artifact Name: $($ArtifactName)"
LogInfo "PullRequest Number: $($PullRequestNumber)"
LogInfo "BuildId: $($BuildId)"
LogInfo "Language: $($Language)"
LogInfo "Commit SHA: $($CommitSha)"
LogInfo "Repo Name: $($RepoFullName)"
LogInfo "Project: $($DevopsProject)"
LogGroupEnd
}
Log-Input-Params
if (!($FindArtifactForApiReviewFn -and (Test-Path "Function:$FindArtifactForApiReviewFn")))
{
Write-Host "The function for 'FindArtifactForApiReviewFn' was not found.`
LogError "The function for 'FindArtifactForApiReviewFn' was not found.`
Make sure it is present in eng/scripts/Language-Settings.ps1 and referenced in eng/common/scripts/common.ps1.`
See https://github.com/Azure/azure-sdk-tools/blob/main/doc/common/common_engsys.md#code-structure"
exit 1
@ -103,6 +105,8 @@ if (!($FindArtifactForApiReviewFn -and (Test-Path "Function:$FindArtifactForApiR
$responses = @{}
LogInfo "Processing PackageInfo at $configFileDir"
$packageProperties = Get-ChildItem -Recurse -Force "$configFileDir" `
| Where-Object {
$_.Extension -eq '.json' -and ($_.FullName.Substring($configFileDir.Length + 1) -notmatch '^_.*?[\\\/]')
@ -113,7 +117,7 @@ foreach ($packagePropFile in $packageProperties)
$packageMetadata = Get-Content $packagePropFile | ConvertFrom-Json
$pkgArtifactName = $packageMetadata.ArtifactName ?? $packageMetadata.Name
Write-Host "Processing $($pkgArtifactName)"
LogInfo "Processing $($pkgArtifactName)"
$packages = &$FindArtifactForApiReviewFn $ArtifactPath $pkgArtifactName
@ -121,7 +125,7 @@ foreach ($packagePropFile in $packageProperties)
{
$pkgPath = $packages.Values[0]
$isRequired = Should-Process-Package -pkgPath $pkgPath -packageName $pkgArtifactName
Write-Host "Is API change detect required for $($pkgArtifactName):$($isRequired)"
LogInfo "Is API change detect required for $($pkgArtifactName):$($isRequired)"
if ($isRequired -eq $True)
{
$filePath = $pkgPath.Replace($ArtifactPath , "").Replace("\", "/")
@ -133,16 +137,16 @@ foreach ($packagePropFile in $packageProperties)
}
else
{
Write-Host "Pull request does not have any change for $($pkgArtifactName)). Skipping API change detect."
LogInfo "Pull request does not have any change for $($pkgArtifactName)). Skipping API change detect."
}
}
else
{
Write-Host "No package is found in artifact path to find API changes for $($pkgArtifactName)"
LogInfo "No package is found in artifact path to find API changes for $($pkgArtifactName)"
}
}
foreach($pkg in $responses.keys)
{
Write-Host "API detection request status for $($pkg) : $($responses[$pkg])"
LogInfo "API detection request status for $($pkg) : $($responses[$pkg])"
}