feat: check if PR can be merged by checking mergeable property

redhat-plumbers-in-action · Nov 8, 2023 · 7c6d05b · 7c6d05b
1 parent b20a73f
commit 7c6d05b
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 5 deletions.
diff --git a/dist/action.js b/dist/action.js
diff --git a/dist/action.js.map b/dist/action.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/pull-request.d.ts b/dist/pull-request.d.ts
diff --git a/dist/pull-request.js b/dist/pull-request.js
diff --git a/dist/pull-request.js.map b/dist/pull-request.js.map
diff --git a/dist/schema/pull-request.d.ts b/dist/schema/pull-request.d.ts
diff --git a/dist/schema/pull-request.js b/dist/schema/pull-request.js
diff --git a/dist/schema/pull-request.js.map b/dist/schema/pull-request.js.map
diff --git a/src/action.ts b/src/action.ts
@@ -77,6 +77,16 @@ async function action(
     message.push(`🟢 Pull Request meet requirements, title has correct form`);
   }
 
+  if (pr.mergeable !== true) {
+    err.push(
+      `🔴 Pull Request can't be merged, \`mergeable\` is \`${pr.mergeable}\``
+    );
+  } else {
+    message.push(
+      `🟢 Pull Request meet requirements, \`mergeable\` is \`true\``
+    );
+  }
+
   switch (pr?.mergeableState) {
     case 'clean':
       message.push(

diff --git a/src/pull-request.ts b/src/pull-request.ts
@@ -2,7 +2,7 @@ import { debug } from '@actions/core';
 
 import { CustomOctokit } from './octokit';
 
-import { pullRequestApiSchema } from './schema/pull-request';
+import { PullRequestApi, pullRequestApiSchema } from './schema/pull-request';
 import { PullRequestMetadata } from './schema/input';
 
 export class PullRequest {
@@ -11,6 +11,7 @@ export class PullRequest {
 
   title = '';
   targetBranch = '';
+  mergeable: PullRequestApi['mergeable'] = null;
   mergeableState = 'unknown';
   draft: boolean | undefined;
   currentLabels: string[] = [];
@@ -44,6 +45,7 @@ export class PullRequest {
 
     this.title = safeData.title;
     this.targetBranch = safeData.base;
+    this.mergeable = safeData.mergeable;
     this.mergeableState = safeData.mergeable_state;
     this.currentLabels = safeData.labels;
     this.draft = safeData.draft;

diff --git a/src/schema/pull-request.ts b/src/schema/pull-request.ts
@@ -9,6 +9,7 @@ export const pullRequestApiSchema = z.object({
   ),
   draft: z.boolean(),
   merged: z.boolean(),
+  mergeable: z.boolean().nullable(),
   mergeable_state: z.string(),
 });