Validate checks before merging PRs (#20)

squalrus · github-actions[bot] · commit 0ea5b5e22b10 · 2020-01-26T22:50:14.000Z
Fix #15
diff --git a/.github/workflows/merge-bot.yml b/.github/workflows/merge-bot.yml
@@ -2,16 +2,24 @@ name: Merge Bot
 
 on:
   pull_request:
-    types: [labeled, unlabeled, review_request_removed]
+    types:
+      - labeled
+      - review_request_removed
+      - review_requested
+      - unlabeled
   pull_request_review:
+    types:
+      - dismissed
+      - submitted
+  status:
 
 jobs:
   merge:
     runs-on: ubuntu-latest
     name: Merge
     steps:
     - name: Integration check
-      uses: squalrus/merge-bot@v0.3.1
+      uses: squalrus/merge-bot@master
       with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         test: false
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This action manages pull request integrations by allowing a structured workflow to be defined.
 
-The workflow can use required labels, blocking labels, and require that reviewers sign-off.
+The workflow can use required labels, blocking labels, and require that reviewers sign-off for determining if a pull request should be integrated. By default the pull request will be blocked by incomplete/failing checks.
 
 Once conditions are met the pull request will be integrated and branch deleted.
 
@@ -34,6 +34,10 @@ One or more labels that block the integration. Default is `"do not merge"`.
 
 ![do not merge GitHub label](./assets/blocking-label.png)
 
+### `checks_enabled`
+
+All checks must be completed to be eligible to integrate. Default is `true`.
+
 ### `method`
 
 Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.
@@ -47,8 +51,16 @@ name: Merge Bot
 
 on:
   pull_request:
-    types: [labeled, unlabeled, review_request_removed]
+    types:
+      - labeled
+      - review_request_removed
+      - review_requested
+      - unlabeled
   pull_request_review:
+    types:
+      - dismissed
+      - submitted
+  status:
 
 jobs:
   merge:
@@ -63,5 +75,6 @@ jobs:
         reviewers: true
         labels: ready, merge
         blocking-labels: do not merge
+        checks: true
         method: squash
 ```
diff --git a/__mocks__/checks/check-0.js b/__mocks__/checks/check-0.js
@@ -0,0 +1,7 @@
+module.exports = {
+    "data": {
+        "total_count": 0,
+        "check_runs": [
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-1a.js b/__mocks__/checks/check-1a.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "queued",
+                "conclusion": null,
+                "started_at": null,
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-1b.js b/__mocks__/checks/check-1b.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "queued",
+                "conclusion": null,
+                "started_at": null,
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-2a.js b/__mocks__/checks/check-2a.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-2b.js b/__mocks__/checks/check-2b.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-2c.js b/__mocks__/checks/check-2c.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-3a.js b/__mocks__/checks/check-3a.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-3b.js b/__mocks__/checks/check-3b.js
@@ -0,0 +1,28 @@
+module.exports = {
+    "data": {
+        "total_count": 3,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "failure",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/checks/check-4a.js b/__mocks__/checks/check-4a.js
@@ -0,0 +1,56 @@
+module.exports = {
+    "data": {
+        "total_count": 7,
+        "check_runs": [
+            {
+                "id": 12345678,
+                "status": "in_progress",
+                "conclusion": null,
+                "started_at": "2020-01-26T00:26:45Z",
+                "completed_at": null
+            },
+            {
+                "id": 23456789,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 34567890,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 45678901,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 56789012,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 67890123,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            },
+            {
+                "id": 78901234,
+                "status": "completed",
+                "conclusion": "success",
+                "started_at": "2020-01-26T00:26:03Z",
+                "completed_at": "2020-01-26T00:26:39Z"
+            }
+        ]
+    }
+};
diff --git a/__mocks__/config/config-complex.js b/__mocks__/config/config-complex.js
@@ -3,5 +3,6 @@ module.exports = {
     "labels": ["good-n-ready", "nice", "okay"],
     "merge_method": "squash",
     "review_required": false,
+    "checks_enabled": true,
     "test_mode": false
 };
diff --git a/__mocks__/config/config-default.js b/__mocks__/config/config-default.js
@@ -3,5 +3,6 @@ module.exports = {
     "labels": ["ready", "merge"],
     "merge_method": "squash",
     "review_required": true,
+    "checks_enabled": true,
     "test_mode": true
 };
diff --git a/__mocks__/config/core-complex.js b/__mocks__/config/core-complex.js
@@ -13,6 +13,9 @@ class CoreComplex {
             case 'reviewers':
                 return 'false';
 
+            case 'checks_enabled':
+                return 'true';
+
             case 'test':
                 return 'false';
 
diff --git a/__mocks__/config/core-default.js b/__mocks__/config/core-default.js
@@ -13,6 +13,9 @@ class CoreDefault {
             case 'reviewers':
                 return 'true';
 
+            case 'checks_enabled':
+                return 'true';
+
             case 'test':
                 return 'true';
 
diff --git a/__mocks__/message/message-expected.js b/__mocks__/message/message-expected.js
@@ -11,6 +11,7 @@ merge method: squash
 labels: [\"foo\",\"bar\",\"ready\"]
 requested reviewers: [\"squalrus\",\"timgrove\"]
 reviewers: []
+checks: {}
 
 #### result
 eligible for merge: false`;
diff --git a/__mocks__/pull/payload-default-expected.js b/__mocks__/pull/payload-default-expected.js
@@ -5,5 +5,6 @@ module.exports = {
     "reviews": [],
     "ref": "heads/master",
     "repo": "merge-bot",
-    "requested_reviewers": ["squalrus", "timgrove"]
+    "requested_reviewers": ["squalrus", "timgrove"],
+    "checks": {}
 };
diff --git a/__tests__/checks.test.js b/__tests__/checks.test.js
diff --git a/__tests__/pull-canmerge.test.js b/__tests__/pull-canmerge.test.js
diff --git a/action.yml b/action.yml
diff --git a/index.js b/index.js
diff --git a/lib/config.js b/lib/config.js
diff --git a/lib/message.js b/lib/message.js
diff --git a/lib/pull.js b/lib/pull.js
