Add check for requiresConversationResolution (#383)

* Add check for requiresConversationResolution

If requiresConversationResolution is set then update-branch will
attempt to merge unmergeable pull requests if there are any
unresolved conversations on the pull request. This takes this setting
into account.

* Use reviewThreads instead of comments

This only includes review comments, not regular comments on pull
requests.

README.md

@@ -65,6 +65,8 @@ jobs:
           fetchMaxPrChecks: 100
           # Optionally set the maximum amount of pull request labels to fetch (default: 10)
           fetchMaxPrLabels: 10
+          # Optionally set the maximum amount of pull request comments to fetch (default: 50)
+          fetchMaxComments: 50
           # The order pr checks should be fetched in. If the required checks are the last ones, consider setting to "last"
           prChecksFetchOrder: first
 ```

action.yml

@@ -43,6 +43,10 @@ inputs:
     required: false
     description: 'The maximum amount of pull request labels to fetch when searching for requiredLabels.'
     default: '10'
+  fetchMaxComments:
+    required: false
+    description: 'The maximum amount of comments to fetch when checking for required conversaion resolution.'
+    default: '50'
   prChecksFetchOrder:
     required: false
     description: 'The order pr checks should be fetched in. If the required checks are the last ones, consider setting to "last"'

src/branchProtection.ts

@@ -16,6 +16,7 @@ export async function getBranchProtectionRules(
             nodes {
               requiredApprovingReviewCount
               requiredStatusCheckContexts
+              requiresConversationResolution
               pattern
             }
           }

src/main.ts

@@ -54,6 +54,7 @@ async function run(): Promise<void> {
       prs: parseInt(core.getInput('fetchMaxPr')),
       checks: parseInt(core.getInput('fetchMaxPrChecks')),
       labels: parseInt(core.getInput('fetchMaxPrLabels')),
+      comments: parseInt(core.getInput('fetchMaxComments')),
       prRunsContextOrder
     }
 
@@ -72,6 +73,8 @@ async function run(): Promise<void> {
         requiredApprovals ||
         (branchProtectionRule?.requiredApprovingReviewCount ?? 0),
       allRequestedReviewersMustApprove,
+      requiresConversationResolution:
+        branchProtectionRule?.requiresConversationResolution ?? false,
       requiredStatusChecks: [
         ...requiredStatusChecks,
         ...(branchProtectionRule?.requiredStatusCheckContexts ?? [])

src/pullRequest.ts

@@ -135,6 +135,11 @@ function getPullRequestFragment(cfg: FetchConfig): string {
       name
     }
   }
+  reviewThreads(last: ${cfg.comments}) {
+    nodes {
+      isResolved
+    }
+  }
   commits(last: 1) {
     nodes {
       commit {

src/type.ts

@@ -3,6 +3,7 @@ import {Octokit} from '@octokit/core'
 export interface FetchConfig {
   prs: number
   labels: number
+  comments: number
   checks: number
   prRunsContextOrder: 'first' | 'last'
 }
@@ -20,6 +21,7 @@ export interface Condition {
   requiredApprovals: number
   requiredStatusChecks: string[]
   allRequestedReviewersMustApprove: boolean
+  requiresConversationResolution: boolean
   requiredLabels: string[]
 }
 
@@ -74,6 +76,9 @@ export interface PullRequestInfo {
   labels: {
     nodes: LabelInfo[]
   }
+  reviewThreads: {
+    nodes: ReviewThread[]
+  }
   number: number
   merged: boolean
   mergeable: MergeableState
@@ -89,6 +94,10 @@ export interface IssueInfo {
   updatedAt?: string
 }
 
+export interface ReviewThread {
+  isResolved: boolean
+}
+
 export interface CommitInfo {
   commit: {
     statusCheckRollup?: StatusCheckRollupInfo
@@ -119,6 +128,7 @@ export interface BranchProtectionRuleInfo {
   pattern: string
   requiredApprovingReviewCount?: number
   requiredStatusCheckContexts: string[]
+  requiresConversationResolution: boolean
 }
 
 export interface RepositoryData<T> {

src/utils.ts

@@ -28,6 +28,10 @@ export function stringify<T>(obj: T): string {
   return JSON.stringify(obj, null, 2)
 }
 
+function checkConversationResolution(pr: PullRequestInfo): boolean {
+  return pr.reviewThreads.nodes.every(v => v.isResolved)
+}
+
 // Except status check
 function isSatisfyBasicConditionPr(
   pr: PullRequestInfo,
@@ -40,7 +44,9 @@ function isSatisfyBasicConditionPr(
     (pr.reviewRequests.totalCount === 0 ||
       !condition.allRequestedReviewersMustApprove) &&
     hasLabels(pr, condition) &&
-    minimatch(pr.baseRefName, condition.branchNamePattern ?? '*')
+    minimatch(pr.baseRefName, condition.branchNamePattern ?? '*') &&
+    (!condition.requiresConversationResolution ||
+      checkConversationResolution(pr))
   )
 }