APIView Creation from PR for Go #24000
+140
−61
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -101,13 +101,11 @@ function Get-AllPackageInfoFromRepo($serviceDirectory) | |
| $searchPath = Join-Path $RepoRoot "sdk" | ||
| $pkgFiles = @() | ||
| if ($serviceDirectory) { | ||
|
There was a problem hiding this comment. Previous code was not doing recursive search when service directory is passed. I think Go has sub modules which contains go.mod and that's probably the reason we don't do Recurse to find package in service directory. @benbp Can you please confirm if sub module also can have go.mod? There was a problem hiding this comment. In most cases the go.mod is not at the service directory level, which is why old logic did not work |
||
| $searchPath = Join-Path $searchPath $serviceDirectory | ||
| } | ||
|
|
||
| [array]$pkgFiles = Get-ChildItem -Path $searchPath -Include "go.mod" -Recurse | ||
|
|
||
| foreach ($pkgFile in $pkgFiles) | ||
| { | ||
| $modPropertes = Get-GoModuleProperties $pkgFile.DirectoryName | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| Write-Host "$PSScriptRoot" | ||
| . (Join-Path $PSScriptRoot .. common scripts common.ps1) | ||
|
|
||
| <# | ||
| .DESCRIPTION | ||
| Create .gosource APIVIew artifact for go | ||
| .PARAMETER ServiceDirectory | ||
| Thee name of the ServiceDirectory | ||
| .PARAMETER OutputDirectory | ||
| Base output Directory path for the generated gosource artifacts | ||
| .PARAMETER DirectoryToPublish | ||
| Directory containing all artifacts to be publisehd to the pipeline | ||
| #> | ||
| function New-APIViewArtifacts { | ||
| Param( | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $ServiceDirectory, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $OutputDirectory, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $DirectoryToPublish | ||
| ) | ||
|
|
||
| foreach ($sdk in (Get-AllPackageInfoFromRepo $ServiceDirectory)) | ||
| { | ||
| Write-Host "Creating API review artifact for $($sdk.Name)" | ||
| $sdkDirectoryPath = Join-Path -Path $OutputDirectory $sdk.Name | ||
| New-Item -ItemType Directory -Path $sdkDirectoryPath -force | ||
| $fileName = Split-Path -Path $sdk.Name -Leaf | ||
| $compressedArchivePath = Join-Path $sdkDirectoryPath "$fileName.zip" | ||
| Compress-Archive -Path $sdk.DirectoryPath -DestinationPath $compressedArchivePath -force | ||
| Rename-Item $compressedArchivePath -NewName "$fileName.gosource" | ||
|
|
||
| $artifactParentDirectory = $sdk.Name -Split "/" | Select-Object -First 1 | ||
| Copy-Item "$OutputDirectory/$artifactParentDirectory" -Destination "$DirectoryToPublish/$artifactParentDirectory" -Recurse | ||
| } | ||
| } | ||
|
|
||
| <# | ||
| .DESCRIPTION | ||
| Create new automatic APIView from a CI run | ||
| .PARAMETER ServiceDirectory | ||
| Thee name of the ServiceDirectory | ||
| .PARAMETER ArtifactPath | ||
| Directory containing the gosources artifact | ||
| .PARAMETER ApiKey | ||
| The APIview ApiKey | ||
| .PARAMETER SourceBranch | ||
| SourceBranch | ||
| .PARAMETER DefaultBranch | ||
| DefaultBranch | ||
| .PARAMETER ConfigFileDir | ||
| Path to the ConfigFileDir as published in the pipeline | ||
| .PARAMETER RepoName | ||
| The name of the repository | ||
| .PARAMETER BuildId | ||
| The build Id of the pipeline run | ||
| .PARAMETER MarkPackageAsShipped | ||
| Indicate weather to mark the package a s shipped | ||
| #> | ||
| function New-APIViewFromCI { | ||
| Param( | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $ServiceDirectory, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $ArtifactPath, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $ApiKey, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $SourceBranch, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $DefaultBranch, | ||
| [Parameter(Mandatory=$True)] | ||
| [string] $ConfigFileDir, | ||
| [string] $RepoName, | ||
| [string] $BuildId, | ||
| [bool] $MarkPackageAsShipped = $false | ||
| ) | ||
| $artifactList = @() | ||
|
|
||
| Get-AllPackageInfoFromRepo $ServiceDirectory | ForEach-Object { | ||
| $artifactList += [PSCustomObject]@{ | ||
| name = $sdk.Name | ||
| } | ||
| } | ||
|
|
||
| $createReviewScript = (Join-Path $PSScriptRoot .. common scripts Create-APIReview.ps1) | ||
|
|
||
| Write-Host "Create Go APIView using generated artifacts" | ||
| &($createReviewScript) ` | ||
| -ArtifactList $artifactList ` | ||
| -ArtifactPath $ArtifactPath ` | ||
| -APIKey $ApiKey ` | ||
| -SourceBranch $SourceBranch ` | ||
| -DefaultBranch $DefaultBranch ` | ||
| -ConfigFileDir $ConfigFileDir ` | ||
| -RepoName $RepoName ` | ||
| -BuildId $BuildId ` | ||
| -MarkPackageAsShipped $MarkPackageAsShipped | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't we still need old PackageInfo for other EngSys tools?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so. All calls to it are from the $(ArtifactStagingDirectory) where it is initially created.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, It is being downloaded in the go release job
azure-sdk-for-go/eng/pipelines/templates/jobs/archetype-go-release.yml
Line 63 in d6bd6b7
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see it being used though. However, I have added another publish step for PackageInfo artifact.