SamuelCabralCruz / unresolved-review-threads

GitHub Action to prevent the merge of pull request having unresolved review threads

unresolved-review-threads

GitHub Action to prevent the merge of pull request having unresolved review threads.

Example Usage

• Create a unresolvedReviewThreads.yml file with the following content:

  name: 'Unresolved Review Threads'
  
  on:
    pull_request_review_comment:
      types: [edited, deleted]
  
    pull_request_review:
      types: [submitted, edited, dismissed]
  
    pull_request:
      types: [opened, reopened, labeled, unlabeled, synchronize, review_requested, review_request_removed]
      branches:
        - main
  
  jobs:
    unresolvedReviewThreads:
      runs-on: ubuntu-latest
      steps:
        - uses: SamuelCabralCruz/unresolved-review-threads@v1.x
          env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

• Don't forget to enforce the check in your branch rule settings

Probot/Settings

If you use probot/settings to configure your repository, you should edit your settings.yml with something similar to the following.

labels:
  - name: unresolvedThreads
    color: '#333333'
    description: Add or remove this label to manually trigger UnresolvedReviewThreads check.
  - name: ignoreUnresolved
    color: '#333333'
    description: Indicate to skip the unresolved review threads check on a specific pull request.

branches:
  - name: main
    protection:
      required_status_checks:
        strict: true
        contexts: ['Unresolved Review Threads']
      enforce_admins: true
      required_signatures: true
      required_linear_history: true
      restrictions: null

Inputs

• unresolvedLabel: Specify the name of the label to mark a pull request having unresolved review threads.
  • required: false
  • default value: unresolvedThreads
• bypassLabel: Specify the name of the label to ignore the unresolved threads check on a given pull request.
  • required: false
  • default value: ignoreUnresolved

Workflow

• This action flow is currently a lot more complicated than it would otherwise be if GitHub Actions could be triggered on
  • Limitations
    • pull_request_review_comment with types: ['resolved', 'unresolved']
    • issue_comment with types: ['reaction']
  • Please take time to go upvote the following tickets to help make this change happen
    • GitHub Community #132292
    • GitHub Community #119961
  • Adding pending status check to pull request does not reflect into the pull request
• For the time being, I opted for the following workaround flow
  • Verification Flow
    • check for unresolved review threads
    • if any unresolved threads
      • add unresolved label
    • otherwise
      • remove unresolved label if present
    • add commit status based on result
    • remove synchronisation label if present
  • How it is intended to be used?
    • Open a pull request
      • Will trigger flow naturally and mark pull request as passing
    • Request for review
    • Enable auto-merge on pull request
    • Reviewers leave comments
      • Will trigger flow and mark pull request as failing
    • Reviewers may approve pull request at that point if the raised concerns are not blocking/major

      Make sure the Unresolved Review Threads check is required into your branch protection rules

    • Discuss raised comments
    • Update pull request
    • Mark review threads as resolved
    • When you are done resolving comments, remove the unresolved label to trigger flow manually
      • if no unresolved review thread is found, the pull request will be marked as passing
    • If auto-merge was enabled and all checks are passing, the pull request is merged
• This flow is far from perfect, but aim at producing the more friction less experience possible considering technological limitations