Add an option to support creating automatic APIreview from manual pipe… (Azure#28981)

* Add an option to support creating automatic API review from manual pipeline run only

Author: praveenkuttappan

eng/pipelines/templates/jobs/ci.yml

@@ -61,6 +61,9 @@ parameters:
   - name: TestProxy
     type: boolean
     default: false
+  - name: GenerateApiReviewForManualOnly
+    type: boolean
+    default: false
 
 jobs:
   - job: 'Build'
@@ -132,6 +135,7 @@ jobs:
         Artifacts: ${{ parameters.Artifacts }}
         VerifyAutorest: ${{ parameters.VerifyAutorest }}
         ValidateFormatting: ${{ parameters.ValidateFormatting }}
+        GenerateApiReviewForManualOnly: ${{ parameters.GenerateApiReviewForManualOnly }}
 
   - job: Compliance
     pool:

eng/pipelines/templates/stages/archetype-sdk-client.yml

@@ -72,6 +72,9 @@ parameters:
 - name: TestProxy
   type: boolean
   default: false
+- name: GenerateApiReviewForManualOnly
+  type: boolean
+  default: false
 
 variables:
   - template: /eng/pipelines/templates/variables/globals.yml
@@ -106,6 +109,7 @@ stages:
         VerifyAutorest: ${{ parameters.VerifyAutorest }}
         ValidateFormatting: ${{ parameters.ValidateFormatting }}
         TestProxy: ${{ parameters.TestProxy }}
+        GenerateApiReviewForManualOnly: ${{ parameters.GenerateApiReviewForManualOnly }}
 
   # The Prerelease and Release stages are conditioned on whether we are building a pull request and the branch.
   - ${{if and(ne(variables['Build.Reason'], 'PullRequest'), eq(variables['System.TeamProject'], 'internal'))}}:

eng/pipelines/templates/steps/analyze.yml

@@ -6,6 +6,7 @@ parameters:
   TestPipeline: false
   VerifyAutorest: false
   ValidateFormatting: false
+  GenerateApiReviewForManualOnly: false
 
 # The variable TargetingString is set by template `eng/pipelines/templates/steps/targeting-string-resolve.yml`. This template is invoked from yml files:
 #     eng/pipelines/templates/jobs/ci.tests.yml
@@ -140,6 +141,7 @@ steps:
   - template: /eng/pipelines/templates/steps/create-apireview.yml
     parameters:
       Artifacts: ${{ parameters.Artifacts }}
+      GenerateApiReviewForManualOnly: ${{ parameters.GenerateApiReviewForManualOnly }}
 
   - template: /eng/common/pipelines/templates/steps/detect-api-changes.yml
     parameters:

eng/pipelines/templates/steps/create-apireview.yml

@@ -4,34 +4,38 @@ parameters:
   ConfigFileDir: $(Build.ArtifactStagingDirectory)/PackageInfo
   Language: 'Python'
   APIViewUri: 'https://apiview.dev/AutoReview/CreateApiReview'
+  GenerateApiReviewForManualOnly: false
 
 steps:
   # ideally this should be done as initial step of a job in caller template
   # We can remove this step later once it is added in caller
   - template: /eng/common/pipelines/templates/steps/set-default-branch.yml
-
-  - task: Powershell@2
-    inputs:
-      filePath: $(Build.SourcesDirectory)/eng/scripts/Create-ApiReview.ps1
-      arguments: >
-        -ArtifactList ('${{ convertToJson(parameters.Artifacts) }}' | ConvertFrom-Json | Select-Object Name)
-        -ArtifactPath ${{ parameters.ArtifactPath }}
-        -APIViewUri ${{ parameters.APIViewUri }}
-        -APIKey $(azuresdk-apiview-apikey)
-        -SourceBranch $(Build.SourceBranchName)
-        -DefaultBranch $(DefaultBranch)
-        -ConfigFileDir '${{ parameters.ConfigFileDir }}'
-        -BuildId $(Build.BuildId)
-        -RepoName $(Build.Repository.Name)
-        -Language ${{ parameters.Language }}
-      pwsh: true
-      workingDirectory: $(Pipeline.Workspace)
-    displayName: Create Automatic API Review
-    condition: >-
-      and(
-        succeededOrFailed(),
-        ne(variables['Skip.CreateApiReview'], 'true'),
-        ne(variables['Build.Reason'],'PullRequest'),
-        eq(variables['System.TeamProject'], 'internal'),
-        not(endsWith(variables['Build.Repository.Name'], '-pr'))
-      )
+ 
+  # Automatic API review is generated for a package when pipeline runs irrespective of how pipeline gets triggered.
+  # Below condition ensures that API review is generated only for manual pipeline runs when flag GenerateApiReviewForManualOnly is set to true. 
+  - ${{ if or(ne(parameters.GenerateApiReviewForManualOnly, true), eq(variables['Build.Reason'], 'Manual')) }}:
+    - task: Powershell@2
+      inputs:
+        filePath: $(Build.SourcesDirectory)/eng/scripts/Create-ApiReview.ps1
+        arguments: >
+          -ArtifactList ('${{ convertToJson(parameters.Artifacts) }}' | ConvertFrom-Json | Select-Object Name)
+          -ArtifactPath ${{ parameters.ArtifactPath }}
+          -APIViewUri ${{ parameters.APIViewUri }}
+          -APIKey $(azuresdk-apiview-apikey)
+          -SourceBranch $(Build.SourceBranchName)
+          -DefaultBranch $(DefaultBranch)
+          -ConfigFileDir '${{ parameters.ConfigFileDir }}'
+          -BuildId $(Build.BuildId)
+          -RepoName $(Build.Repository.Name)
+          -Language ${{ parameters.Language }}
+        pwsh: true
+        workingDirectory: $(Pipeline.Workspace)
+      displayName: Create Automatic API Review
+      condition: >-
+        and(
+          succeededOrFailed(),
+          ne(variables['Skip.CreateApiReview'], 'true'),
+          ne(variables['Build.Reason'],'PullRequest'),
+          eq(variables['System.TeamProject'], 'internal'),
+          not(endsWith(variables['Build.Repository.Name'], '-pr'))
+        )

sdk/ml/ci.yml

@@ -31,6 +31,10 @@ extends:
     ValidateFormatting: true
     TestTimeoutInMinutes: 75
     TestProxy: true
+    # This is a short term solution to create API review for python azure-ml package only when running pipeline manually
+    # Long term solution should be to have different versions on main branch and release branch for python package so APIView can have different revisions for each version.
+    # Tracking issue: https://github.com/Azure/azure-sdk-for-python/issues/29196
+    GenerateApiReviewForManualOnly: true
     Artifacts:
     - name: azure-ai-ml
       safeName: azureaiml