create-apireview.yml•2.12 kB
parameters:
  ArtifactPath: $(Build.ArtifactStagingDirectory)
  Artifacts: []
  ConfigFileDir: $(Build.ArtifactStagingDirectory)/PackageInfo
  MarkPackageAsShipped: false
  GenerateApiReviewForManualOnly: false
  ArtifactName: 'packages'
  PackageName: ''
  SourceRootPath: $(Build.SourcesDirectory)
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
    parameters:
      WorkingDirectory: ${{ parameters.SourceRootPath }}
  # 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: ${{ parameters.SourceRootPath }}/eng/common/scripts/Create-APIReview.ps1
        arguments: >
          -ArtifactList ('${{ convertToJson(parameters.Artifacts) }}' | ConvertFrom-Json | Select-Object Name)
          -ArtifactPath '${{parameters.ArtifactPath}}'
          -ArtifactName ${{ parameters.ArtifactName }}
          -APIKey '$(azuresdk-apiview-apikey)'
          -PackageName '${{parameters.PackageName}}'
          -SourceBranch '$(Build.SourceBranchName)'
          -DefaultBranch '$(DefaultBranch)'
          -ConfigFileDir '${{parameters.ConfigFileDir}}'
          -BuildId '$(Build.BuildId)'
          -RepoName '$(Build.Repository.Name)'    
          -MarkPackageAsShipped $${{parameters.MarkPackageAsShipped}}
        pwsh: true
      displayName: Create 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'))
        )