Add merge queue support

Supports pull request enqueue/dequeue subevents + ignore spammy events related to merge queue

Author: JRoy

README.md

@@ -18,6 +18,7 @@ disgit has the following optional environment variables that you can use to cust
 - `IGNORED_USERS` - A comma seperated list of users that should be ignored
 - `IGNORED_PAYLOADS` - A comma seperated list of webhook events that should be ignored
 - `DEBUG_PASTE` - Set to `true` to enable debug embeds.
+- `EXECUTE_MERGE_QUEUE_BRANCHES` - Set to `true` to unignore merge queue related branches.
 
 ## Supported Events
 The following webhook events are supported as of now;

src/env.ts

@@ -11,6 +11,7 @@ export interface Env {
 
     DEBUG_PASTE: string;
     AWAIT_ERRORS: string;
+    EXECUTE_MERGE_QUEUE_BRANCHES: string;
 }
 
 /**
@@ -24,6 +25,7 @@ export class BoundEnv {
     readonly githubWebhookSecret: string;
     readonly debugPaste: boolean;
     readonly awaitErrors: boolean;
+    readonly executeMergeQueueBranches: boolean;
 
     constructor(env: Env) {
         if (typeof env.IGNORED_BRANCHES_REGEX !== 'undefined') {
@@ -35,13 +37,18 @@ export class BoundEnv {
         this.githubWebhookSecret = env.GITHUB_WEBHOOK_SECRET;
         this.debugPaste = env.DEBUG_PASTE == "true" || env.DEBUG_PASTE == "1";
         this.awaitErrors = env.AWAIT_ERRORS == "true" || env.AWAIT_ERRORS == "1";
+        this.executeMergeQueueBranches = env.EXECUTE_MERGE_QUEUE_BRANCHES == "true" || env.EXECUTE_MERGE_QUEUE_BRANCHES == "1";
     }
 
     /**
      * @param {String} branch
      * @return {boolean}
      */
     isIgnoredBranch(branch: string): boolean {
+        if (!this.executeMergeQueueBranches && branch.startsWith('gh-readonly-queue/')) {
+            return true;
+        }
+
         return (this.ignoredBranchPattern && branch.match(this.ignoredBranchPattern) != null) || this.ignoredBranches.includes(branch);
     }
 

src/index.ts

@@ -148,6 +148,12 @@ function buildEmbed(json: any, event: string, env: BoundEnv): string | null {
                 case "ready_for_review": {
                     return buildPullReadyReview(json);
                 }
+                case "enqueued": {
+                    return buildPullEnqueue(json);
+                }
+                case "dequeued": {
+                    return buildPullDequeue(json);
+                }
                 default: {
                     return null;
                 }
@@ -308,6 +314,34 @@ function buildPush(json: any, env: BoundEnv): string | null {
     );
 }
 
+function buildPullEnqueue(json: any): string {
+    const { pull_request, repository, sender } = json;
+
+    const queueUrl = `${repository["html_url"]}/queue/${pull_request.base.ref}`;
+
+    return buildEmbedBody(
+        `[${repository["full_name"]}] Pull request enqueued: #${pull_request.number} ${pull_request.title}`,
+        pull_request["html_url"],
+        sender,
+        16752896,
+        `[View \`${pull_request.base.ref}\` merge queue](${queueUrl})`
+    );
+}
+
+function buildPullDequeue(json: any): string {
+    const { pull_request, repository, sender } = json;
+
+    const queueUrl = `${repository["html_url"]}/queue/${pull_request.base.ref}`;
+
+    return buildEmbedBody(
+        `[${repository["full_name"]}] Pull request dequeued: #${pull_request.number} ${pull_request.title}`,
+        pull_request["html_url"],
+        sender,
+        13584462,
+        `[View \`${pull_request.base.ref}\` merge queue](${queueUrl})`
+    );
+}
+
 function buildPullReviewComment(json: any): string {
     const { pull_request, comment, repository, sender } = json;
 

wrangler.toml

@@ -10,6 +10,7 @@ IGNORED_BRANCHES=""
 IGNORED_USERS=""
 IGNORED_PAYLOADS=""
 DEBUG_PASTE=false
+EXECUTE_MERGE_QUEUE_BRANCHES=false
 
 # Uses secrets:
 # - GITHUB_WEBHOOK_SECRET