Implement the ability to auto-merge an arbitrary pull request (#149)

Implement support for arbitrary pull requests Co-authored-by: Pascal
pascalgn · May 11, 2021 · 042e737 · 042e737
1 parent ebf03a4
commit 042e737
Show file tree

Hide file tree

Showing 5 changed files with 278 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -195,6 +195,8 @@ Also, the following general options are supported:
   so make sure to add it as secret, not as environment variable, in the GitHub
   workflow file!
 
+- `PULL_REQUEST`: If provided, this action will attempt to merge the specified pull request. By default, it will attempt to use the pull request specified in the GitHub context. If a pull request number is provided via this input, this action will search in the current repo for the provided pull request number. If you want to merge a pull request in another repo, just provide the repo slug before the pull request number, like `Some-Org/Some-Repo/1234`
+
 You can configure the environment variables in the workflow file like this:
 
 ```yaml
@@ -209,6 +211,7 @@ You can configure the environment variables in the workflow file like this:
           MERGE_RETRY_SLEEP: "10000"
           UPDATE_LABELS: ""
           UPDATE_METHOD: "rebase"
+          PULL_REQUEST: "1234"
 ```
 
 ## Supported Events

diff --git a/dist/index.js b/dist/index.js
@@ -195,7 +195,9 @@ async function executeGitHubAction(context, eventName, eventData) {
   logger.info("Event name:", eventName);
   logger.trace("Event data:", eventData);
 
-  if (["push"].includes(eventName)) {
+  if (context.config.pullRequest != null) {
+    await handleArbitraryPullRequestUpdate(context, eventData);
+  } else if (["push"].includes(eventName)) {
     await handleBaseBranchUpdate(context, eventName, eventData);
   } else if (["status"].includes(eventName)) {
     await handleStatusUpdate(context, eventName, eventData);
@@ -233,6 +235,34 @@ async function handlePullRequestUpdate(context, eventName, event) {
   await merge(context, pullRequest);
 }
 
+async function handleArbitraryPullRequestUpdate(context, eventData) {
+  const { config, octokit } = context;
+
+  const repoOwner =
+    config.pullRequest.repoOwner || eventData.repository.owner.login;
+  const repoName = config.pullRequest.repoName || eventData.repository.name;
+  const { pullRequestNumber } = config.pullRequest;
+
+  logger.info(`Looking for pull request #${pullRequestNumber}...`);
+
+  try {
+    const { data: pullRequest } = await octokit.pulls.get({
+      owner: repoOwner,
+      repo: repoName,
+      pull_number: pullRequestNumber
+    });
+    logger.trace("Full PR:", pullRequest);
+
+    await update(context, pullRequest);
+    await merge(context, pullRequest);
+  } catch (e) {
+    logger.error(
+      `Error fetching pull request: ${repoOwner}/${repoName}/${pullRequestNumber}`
+    );
+    throw e;
+  }
+}
+
 async function handleCheckUpdate(context, eventName, event) {
   const { action } = event;
   if (action !== "completed") {
@@ -517,7 +547,6 @@ module.exports = { executeLocally, executeGitHubAction };
 
 const util = __webpack_require__(1669);
 const process = __webpack_require__(1765);
-
 const fse = __webpack_require__(5630);
 const tmp = __webpack_require__(8517);
 
@@ -611,7 +640,7 @@ function createConfig(env = {}) {
     if (val == null || val === "") {
       return defaultValue;
     } else {
-      const number = parseInt(val);
+      const number = parseInt(val, 10);
       if (isNaN(number) || number < 0) {
         throw new ClientError(`Not a positive integer: ${val}`);
       } else {
@@ -620,6 +649,50 @@ function createConfig(env = {}) {
     }
   }
 
+  function parsePullRequest(pullRequest) {
+    if (!pullRequest) {
+      return null;
+    }
+
+    logger.info(`Parsing PULL_REQUEST input: ${pullRequest}`);
+
+    const error = new ClientError(
+      `Invalid value provided for input PULL_REQUEST: ${pullRequest}. Must be a positive integer, optionally prefixed by a repo slug.`
+    );
+
+    if (typeof pullRequest === "string") {
+      let repoOwner;
+      let repoName;
+      let pullRequestNumber;
+
+      const destructuredPullRequest = pullRequest.split("/");
+      if (destructuredPullRequest.length === 3) {
+        [repoOwner, repoName, pullRequestNumber] = destructuredPullRequest;
+      } else if (destructuredPullRequest.length === 1) {
+        [pullRequestNumber] = destructuredPullRequest;
+      } else {
+        throw error;
+      }
+
+      pullRequestNumber = parseInt(pullRequestNumber, 10);
+      if (isNaN(pullRequestNumber) || pullRequestNumber <= 0) {
+        throw error;
+      }
+
+      return {
+        repoOwner,
+        repoName,
+        pullRequestNumber
+      };
+    }
+
+    if (typeof pullRequest === "number" && pullRequest > 0) {
+      return { pullRequestNumber: pullRequest };
+    }
+
+    throw error;
+  }
+
   const mergeLabels = parseMergeLabels(env.MERGE_LABELS, "automerge");
   const mergeRemoveLabels = parseMergeRemoveLabels(env.MERGE_REMOVE_LABELS, "");
   const mergeMethod = env.MERGE_METHOD || "merge";
@@ -638,6 +711,8 @@ function createConfig(env = {}) {
   const updateRetries = parsePositiveInt("UPDATE_RETRIES", 1);
   const updateRetrySleep = parsePositiveInt("UPDATE_RETRY_SLEEP", 5000);
 
+  const pullRequest = parsePullRequest(env.PULL_REQUEST);
+
   return {
     mergeLabels,
     mergeRemoveLabels,
@@ -654,7 +729,8 @@ function createConfig(env = {}) {
     updateLabels,
     updateMethod,
     updateRetries,
-    updateRetrySleep
+    updateRetrySleep,
+    pullRequest
   };
 }
 

diff --git a/lib/api.js b/lib/api.js
@@ -60,7 +60,9 @@ async function executeGitHubAction(context, eventName, eventData) {
   logger.info("Event name:", eventName);
   logger.trace("Event data:", eventData);
 
-  if (["push"].includes(eventName)) {
+  if (context.config.pullRequest != null) {
+    await handleArbitraryPullRequestUpdate(context, eventData);
+  } else if (["push"].includes(eventName)) {
     await handleBaseBranchUpdate(context, eventName, eventData);
   } else if (["status"].includes(eventName)) {
     await handleStatusUpdate(context, eventName, eventData);
@@ -98,6 +100,34 @@ async function handlePullRequestUpdate(context, eventName, event) {
   await merge(context, pullRequest);
 }
 
+async function handleArbitraryPullRequestUpdate(context, eventData) {
+  const { config, octokit } = context;
+
+  const repoOwner =
+    config.pullRequest.repoOwner || eventData.repository.owner.login;
+  const repoName = config.pullRequest.repoName || eventData.repository.name;
+  const { pullRequestNumber } = config.pullRequest;
+
+  logger.info(`Looking for pull request #${pullRequestNumber}...`);
+
+  try {
+    const { data: pullRequest } = await octokit.pulls.get({
+      owner: repoOwner,
+      repo: repoName,
+      pull_number: pullRequestNumber
+    });
+    logger.trace("Full PR:", pullRequest);
+
+    await update(context, pullRequest);
+    await merge(context, pullRequest);
+  } catch (e) {
+    logger.error(
+      `Error fetching pull request: ${repoOwner}/${repoName}/${pullRequestNumber}`
+    );
+    throw e;
+  }
+}
+
 async function handleCheckUpdate(context, eventName, event) {
   const { action } = event;
   if (action !== "completed") {

diff --git a/lib/common.js b/lib/common.js
@@ -1,6 +1,5 @@
 const util = require("util");
 const process = require("process");
-
 const fse = require("fs-extra");
 const tmp = require("tmp");
 
@@ -94,7 +93,7 @@ function createConfig(env = {}) {
     if (val == null || val === "") {
       return defaultValue;
     } else {
-      const number = parseInt(val);
+      const number = parseInt(val, 10);
       if (isNaN(number) || number < 0) {
         throw new ClientError(`Not a positive integer: ${val}`);
       } else {
@@ -103,6 +102,50 @@ function createConfig(env = {}) {
     }
   }
 
+  function parsePullRequest(pullRequest) {
+    if (!pullRequest) {
+      return null;
+    }
+
+    logger.info(`Parsing PULL_REQUEST input: ${pullRequest}`);
+
+    const error = new ClientError(
+      `Invalid value provided for input PULL_REQUEST: ${pullRequest}. Must be a positive integer, optionally prefixed by a repo slug.`
+    );
+
+    if (typeof pullRequest === "string") {
+      let repoOwner;
+      let repoName;
+      let pullRequestNumber;
+
+      const destructuredPullRequest = pullRequest.split("/");
+      if (destructuredPullRequest.length === 3) {
+        [repoOwner, repoName, pullRequestNumber] = destructuredPullRequest;
+      } else if (destructuredPullRequest.length === 1) {
+        [pullRequestNumber] = destructuredPullRequest;
+      } else {
+        throw error;
+      }
+
+      pullRequestNumber = parseInt(pullRequestNumber, 10);
+      if (isNaN(pullRequestNumber) || pullRequestNumber <= 0) {
+        throw error;
+      }
+
+      return {
+        repoOwner,
+        repoName,
+        pullRequestNumber
+      };
+    }
+
+    if (typeof pullRequest === "number" && pullRequest > 0) {
+      return { pullRequestNumber: pullRequest };
+    }
+
+    throw error;
+  }
+
   const mergeLabels = parseMergeLabels(env.MERGE_LABELS, "automerge");
   const mergeRemoveLabels = parseMergeRemoveLabels(env.MERGE_REMOVE_LABELS, "");
   const mergeMethod = env.MERGE_METHOD || "merge";
@@ -121,6 +164,8 @@ function createConfig(env = {}) {
   const updateRetries = parsePositiveInt("UPDATE_RETRIES", 1);
   const updateRetrySleep = parsePositiveInt("UPDATE_RETRY_SLEEP", 5000);
 
+  const pullRequest = parsePullRequest(env.PULL_REQUEST);
+
   return {
     mergeLabels,
     mergeRemoveLabels,
@@ -137,7 +182,8 @@ function createConfig(env = {}) {
     updateLabels,
     updateMethod,
     updateRetries,
-    updateRetrySleep
+    updateRetrySleep,
+    pullRequest
   };
 }