Git Pull request

Question

Need a API point or option where as reviewer I should click checkboxes mandatorily to ensure those checklist are fulfilled and not as PR template.

Similar to this I found for traditionally UI in the below link:

https://www.pullchecklist.com/

How Do i Raise request for this?

Answer 1

Hi K C, Soniya

To request a mandatory reviewer checklist UI directly on the Azure DevOps, pull request page (not just a markdown template), you’ll want to submit a formal feature request to Microsoft via their official feedback channel: https://developercommunity.visualstudio.com/AzureDevOps by Clicking on “Suggest a Feature” and Describe Your Request Clearly

Hope this helps!

Please Let me know if you have any queries.

If you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.

Answer 2

Hi K C, Soniya

Azure DevOps doesn't natively support checkbox-based checklists like PullChecklist for GitHub, but you can achieve similar functionality using Status Policies and the Pull Request Status API.

Status Policies:

1. Go to Azure DevOps -> Select your Project ->Project Settings -> Repositories -> Branches -> Security -> Git refs permissions -> All Branches -> Status check -> Add -> Enable Required and Reset status whenever there are new changes -> Save.
2. From this if your app or service doesn’t post a state: "succeeded" for the "Reviewer Checklist", PRs can’t be completed. Reviewers will see a failed or pending check until the checklist is fulfilled.

Pull Request Status API:

1. A valid Personal Access Token (PAT) with Code (Read & Write) and Pull Request Status (Read & Write) scopes.

2.    $org = "yourorg"
      $project = "yourproject"
      $repoId = "yourrepoid"
      $prId = 123
      $url = "https://dev.azure.com/$org/$project/_apis/git/repositories/$repoId/pullRequests/$prId/statuses?api-version=7.1-preview.1"
      $body = @{
          state = "succeeded"
          description = "Reviewer checklist completed"
          context = @{
              name = "Reviewer Checklist"
              genre = "compliance"
          }
          targetUrl = "https://your-checklist-app.com"
      } | ConvertTo-Json -Depth 3
      Invoke-RestMethod -Uri $url -Method Post -Headers @{ Authorization = "Basic $base64AuthInfo" } -Body $body -ContentType "application/json"
   

Additional References:

https://stackoverflow.com/questions/64035094/possible-to-create-required-check-pull-request-status

https://learn.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-statuses/create?view=azure-devops-rest-7.1&tabs=HTTP

Hope this helps!

Please Let me know if you have any queries.

If you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.

Answer 3

I had raised this for Azure, We need this in Azure Git pull request.

Answer 4

Hi Reshma,

Thanks for you're response..
I have a question on the alternative approach you have suggested, Does that enforce the reviewer only to mark it as checked or anyone(author or person not part of the review) to mark that as checked.

Thanks,

Soniya

Answer 5

Hi K C, Soniya

GitHub doesn’t natively support mandatory reviewer checklists outside of PR templates.

https://www.pullchecklist.com integrates directly with GitHub.

You can request it through the GitHub Marketplace: https://github.com/marketplace/pull-checklist

Alternatively, use a GitHub Action to Enforce Checklist Completion - https://github.com/marketplace/actions/pr-required-tasks-validator

You can configure it like this:

name: "Check Required PR Tasks"
on:
  pull_request:
    types: [opened, edited, synchronize, reopened]
jobs:
  task-check:
    runs-on: ubuntu-latest
    steps:
      - uses: iukekini/pr-tasks-validator-action@v1.0.4
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"

Then in your PR description:

## Required Tasks
[ ] Code reviewed
[ ] Unit tests verified
[ ] Security checklist completed

This forces reviewers to check off items before merging.

Hope this helps!

Please Let me know if you have any queries.