Azure Pipeline PullRequest Reviewer

The Azure Pipelines PR Reviewer is designed to use the GPT model from OpenAI to review Pull Requests and provide feedback as comments in the Pull Request.

Setup

Before using this extension, ensure that the build service has permissions to contribute to Pull Requests in your repository, and allow the task to access the system token.

Give permission to the build service agent

Allow Task to access the system token

Depending on the type of pipeline you are using, follow one of the two steps below:

Yaml pipelines

Add a checkout section with persistCredentials set to true.

steps:
- checkout: self
  persistCredentials: true

Classic editors

Enable the option "Allow scripts to access the OAuth token" in the "Agent job" properties.

Azure Open AI service

If you choose to use the Azure OpenAI service, you must fill in the endpoint and API key of Azure OpenAI. The format of the endpoint is as follows: https://{XXXXXXXX}.openai.azure.com/openai/deployments/{MODEL_NAME}/chat/completions?api-version={API_VERSION}

Example Pipeline:

# ASP.NET Core (.NET Framework)
# Build and test ASP.NET Core projects targeting the full .NET Framework.
# Add steps that publish symbols, save build artifacts, and more:
# https://docs.microsoft.com/azure/devops/pipelines/languages/dotnet-core

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  solution: '**/*.sln'
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

steps:

- task: NodeTool@0
  inputs:
    versionSource: 'spec'
    versionSpec: '18.17.1'

- checkout: self
  persistCredentials: true

- script: |
    echo $(System.AccessToken)
  env:
   System.AccessToken: $(System.AccessToken)

- task: AzureOpenAIPRReviewer@1
  inputs:
    api_key: <API Key from your organization>
    deployment_id: 'gpt-35-turbo'
    endpoint: <Your API Endpoint>
    support_self_signed_certificate: true

- task: NuGetCommand@2
  inputs:
    restoreSolution: '$(solution)'

- task: VSBuild@1
  inputs:
    solution: '$(solution)'
    msbuildArgs: '/p:DeployOnBuild=true /p:WebPublishMethod=Package /p:PackageAsSingleFile=true /p:SkipInvalidConfigurations=true /p:DesktopBuildPackageLocation="$(build.artifactStagingDirectory)\WebApp.zip" /p:DeployIisAppPath="Default Web Site"'
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

- task: VSTest@2
  inputs:
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'

OpenAI Models

In case you don't use Azure Open AI Service, you can choose which model to use, the supported models are "gpt-4", "gpt-3.5-turbo" and "gpt-3.5-turbo-16k". if no model is selected the "gpt-3.5-turbo" is used.

How to use it

Install the extension

To use the Azure Pipelines PR Reviewer Task, first install the extension in your Azure DevOps organization. Click on the "Get it free" button and follow the prompts to install it. You may need to authorize the extension to access your Azure DevOps account.

Add the task to the build pipeline

After installing the extension, add the task to your build pipeline. Go to your build pipeline, click on the "+" icon to add a new task, and search for "Review PullRequest by GPT". Select it and add it to your pipeline.

Configure the task

Once you have added the task to your pipeline, configure it. In the task configuration, provide your API key for OpenAI API. To create an API key, go to Azure Portal

- task: AzureOpenAIPRReviewer@1
  inputs:
    api_key: <API Key from your organization>
    deployment_id: 'gpt-35-turbo'
    endpoint: <Your API Endpoint>
    support_self_signed_certificate: true

Review Pull Requests

When the build is triggered from a Pull Request, the task will review it. If there is feedback on the changed code, the task will add comments to the Pull Request. If the build is triggered manually, the task will be skipped.

Compatible with Linux Build Agents

The tasks can execute on all supported build agent operating systems including Linux and MacOS.