APIView Creation from PR for Go #24000

chidozieononiwu · 2025-01-23T22:08:34Z

This adds a step to publish .gosource artifact and trigger call to APIView endpoint for detecting API changes

chidozieononiwu · 2025-01-24T05:53:23Z

/azp run go - aztemplate

azure-pipelines · 2025-01-24T05:53:43Z

Azure Pipelines successfully started running 1 pipeline(s).

eng/pipelines/templates/steps/analyze.yml

chidozieononiwu · 2025-01-29T00:31:22Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-29T00:31:35Z

Azure Pipelines successfully started running 1 pipeline(s).

chidozieononiwu · 2025-01-29T02:01:10Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-29T02:01:27Z

Azure Pipelines successfully started running 1 pipeline(s).

weshaggard · 2025-01-29T23:40:44Z

eng/common/scripts/Package-Properties.ps1

@@ -13,6 +13,7 @@ class PackageProps {
    [string]$SdkType
    [boolean]$IsNewSdk
    [string]$ArtifactName
+    [string]$ModuleName


If we can avoid it, I would prefer we not add a new property. I know other languages use ArtifactName for different things and it could potentially be used for module name as well.

I can remove this as it turned out I don't even need it here. Go is not setting ArtifactName but instead Module name is added as NotePropertyName but it does not show up whren the properties are written to the PackageInfo file. Anyways the name property is sufficient for what I need to accomplish right now.

weshaggard · 2025-01-29T23:45:46Z

eng/scripts/Language-Settings.ps1

@@ -58,7 +58,7 @@ function Get-GoModuleProperties($goModPath)
    $pkgProp.SdkType = $sdkType

    $pkgProp | Add-Member -NotePropertyName "VersionFile" -NotePropertyValue $versionFile
-    $pkgProp | Add-Member -NotePropertyName "ModuleName" -NotePropertyValue $modName
+    $pkgProp.ModuleName = $modName


It looks like we use ArtifactName for the modPath and we add to ModName. Can we actually access ModuleName without it being on the base type?

It can be accessed. But in the case where it is written to a file the property does not show up.

chidozieononiwu · 2025-01-30T01:57:28Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-30T01:57:44Z

Azure Pipelines successfully started running 1 pipeline(s).

chidozieononiwu · 2025-01-30T18:20:58Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-30T18:21:19Z

Azure Pipelines successfully started running 1 pipeline(s).

chidozieononiwu · 2025-01-30T18:54:11Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-30T18:54:34Z

Azure Pipelines successfully started running 1 pipeline(s).

chidozieononiwu · 2025-01-30T22:18:40Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-30T22:18:57Z

Azure Pipelines successfully started running 1 pipeline(s).

chidozieononiwu · 2025-01-30T22:35:33Z

/azp run go - aztemplate - ci

azure-pipelines · 2025-01-30T22:35:49Z

Azure Pipelines successfully started running 1 pipeline(s).

praveenkuttappan · 2025-01-31T17:51:49Z

eng/scripts/Language-Settings.ps1

@@ -101,13 +101,11 @@ function Get-AllPackageInfoFromRepo($serviceDirectory)
  $searchPath = Join-Path $RepoRoot "sdk"
  $pkgFiles = @()
  if ($serviceDirectory) {
-    $searchPath = Join-Path $searchPath $serviceDirectory "go.mod"


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?

praveenkuttappan · 2025-01-31T17:53:16Z

eng/scripts/analyze-step-helpers.ps1

+.PARAMETER DirectoryToPublish
+    Directory containing all artifacts to be publisehd to the pipeline
+#>
+function New-GoArtifacts {


Can you please rename this function to Create-ApiView-Artifact to be more specific. Go does not have any artifact and this generic name will be misleading.

praveenkuttappan · 2025-01-31T17:55:51Z

eng/scripts/analyze-step-helpers.ps1

+    foreach ($sdk in (Get-AllPackageInfoFromRepo $ServiceDirectory))
+    {
+        Write-Host "Creating API review artifact for $($sdk.Name)"
+        $sdkDirectoryPath = Join-Path -Path $OutputDirectory $sdk.Name


What's the value of sdk.name? Go has same module name under different path and that's the reason it uses complete sdk path as package name. We cannot use just the name of last folder that contains go.mod to create unique package folders.

praveenkuttappan · 2025-01-31T17:58:56Z

eng/scripts/analyze-step-helpers.ps1

@@ -0,0 +1,100 @@
+Write-Host "$PSScriptRoot"


Can also please rename this script to apiview-helpers.ps1?

praveenkuttappan · 2025-01-31T18:00:12Z

eng/pipelines/templates/steps/analyze.yml

+        -DirectoryToPublish $directoryToPublish
+
+      Copy-Item "$(Build.ArtifactStagingDirectory)/PackageInfo" -Destination $directoryToPublish -Recurse
+    displayName: 'Create Go Package Artifact'


Suggested change

displayName: 'Create Go Package Artifact'

displayName: 'Create Go APIView Artifact'

praveenkuttappan · 2025-01-31T18:02:17Z

eng/pipelines/templates/steps/analyze.yml

  - template: /eng/common/pipelines/templates/steps/publish-1es-artifact.yml
    parameters:
-      ArtifactName: "PackageInfo"


Don't we still need old PackageInfo for other EngSys tools?

chidozieononiwu requested review from benbp and weshaggard as code owners January 23, 2025 22:08

chidozieononiwu requested a review from praveenkuttappan January 23, 2025 22:08

chidozieononiwu self-assigned this Jan 23, 2025

chidozieononiwu added 2 commits January 23, 2025 14:09

APIView Creation from PR for Go

d79ba70

Changes in Template for testing

127671c

chidozieononiwu force-pushed the apiView/goPullRequests branch from 47fbccc to 127671c Compare January 24, 2025 05:51

weshaggard reviewed Jan 28, 2025

View reviewed changes

eng/pipelines/templates/steps/analyze.yml Show resolved Hide resolved

chidozieononiwu requested a review from a team as a code owner January 28, 2025 21:51

chidozieononiwu force-pushed the apiView/goPullRequests branch from 115c5b6 to 4461d43 Compare January 29, 2025 00:27

chidozieononiwu force-pushed the apiView/goPullRequests branch from 4461d43 to 1cc54b9 Compare January 29, 2025 01:59

chidozieononiwu mentioned this pull request Jan 29, 2025

Update common tool to support go Azure/azure-sdk-tools#9733

Open

weshaggard reviewed Jan 29, 2025

View reviewed changes

chidozieononiwu force-pushed the apiView/goPullRequests branch from 1cc54b9 to 1caefd1 Compare January 29, 2025 23:42

weshaggard reviewed Jan 29, 2025

View reviewed changes

chidozieononiwu force-pushed the apiView/goPullRequests branch 2 times, most recently from c9679c9 to d7d3aa0 Compare January 30, 2025 01:09

Update go Language Settings and Detect-Api-Changes

86b795c

chidozieononiwu force-pushed the apiView/goPullRequests branch from d7d3aa0 to 86b795c Compare January 30, 2025 01:14

chidozieononiwu force-pushed the apiView/goPullRequests branch from 70fb42e to 02446d7 Compare January 30, 2025 18:19

chidozieononiwu force-pushed the apiView/goPullRequests branch from 02446d7 to ff7bf90 Compare January 30, 2025 18:52

chidozieononiwu force-pushed the apiView/goPullRequests branch from ff7bf90 to a5290c1 Compare January 30, 2025 22:17

chidozieononiwu force-pushed the apiView/goPullRequests branch from a5290c1 to 5577a33 Compare January 30, 2025 22:34

test Changes manually

b1ead21

chidozieononiwu force-pushed the apiView/goPullRequests branch 10 times, most recently from 22e46a3 to 56c2dae Compare January 31, 2025 08:25

Update Go Analyze Step

a77e679

chidozieononiwu force-pushed the apiView/goPullRequests branch from 56c2dae to a77e679 Compare January 31, 2025 08:39

praveenkuttappan reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

APIView Creation from PR for Go #24000

APIView Creation from PR for Go #24000

chidozieononiwu commented Jan 23, 2025

chidozieononiwu commented Jan 24, 2025

azure-pipelines bot commented Jan 24, 2025

chidozieononiwu commented Jan 29, 2025

azure-pipelines bot commented Jan 29, 2025

chidozieononiwu commented Jan 29, 2025

azure-pipelines bot commented Jan 29, 2025

weshaggard Jan 29, 2025

chidozieononiwu Jan 29, 2025

weshaggard Jan 29, 2025

chidozieononiwu Jan 29, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

praveenkuttappan Jan 31, 2025

praveenkuttappan Jan 31, 2025

praveenkuttappan Jan 31, 2025

praveenkuttappan Jan 31, 2025

praveenkuttappan Jan 31, 2025

praveenkuttappan Jan 31, 2025

	displayName: 'Create Go Package Artifact'
	displayName: 'Create Go APIView Artifact'

APIView Creation from PR for Go #24000

Are you sure you want to change the base?

APIView Creation from PR for Go #24000

Conversation

chidozieononiwu commented Jan 23, 2025

chidozieononiwu commented Jan 24, 2025

azure-pipelines bot commented Jan 24, 2025

chidozieononiwu commented Jan 29, 2025

azure-pipelines bot commented Jan 29, 2025

chidozieononiwu commented Jan 29, 2025

azure-pipelines bot commented Jan 29, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

chidozieononiwu commented Jan 30, 2025

azure-pipelines bot commented Jan 30, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment