feat: add optional draft flag to openPullRequest() (#207)

First step towards Owl Bot opening pull requests. Owl bot invokes this library to open pull requests.
googleapis · Apr 22, 2021 · ff9516c · ff9516c
1 parent b2f440c
commit ff9516c
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 4 deletions.
diff --git a/src/github-handler/pull-request-handler.ts b/src/github-handler/pull-request-handler.ts
@@ -27,6 +27,7 @@ const DEFAULT_PRIMARY = 'master';
  * @param {Description} description The pull request title and detailed description
  * @param {boolean} maintainersCanModify Whether or not maintainers can modify the pull request. Default is true
  * @param {string} upstreamPrimary The upstream repository's primary branch. Default is master.
+ * @param draft Open a DRAFT pull request.  Defaults to false.
  * @returns {Promise<void>}
  */
 async function openPullRequest(
@@ -35,7 +36,8 @@ async function openPullRequest(
   origin: BranchDomain,
   description: Description,
   maintainersCanModify = true,
-  upstreamPrimary: string = DEFAULT_PRIMARY
+  upstreamPrimary: string = DEFAULT_PRIMARY,
+  draft = false
 ): Promise<number> {
   const head = `${origin.owner}:${origin.branch}`;
   const existingPullRequest = (
@@ -60,6 +62,7 @@ async function openPullRequest(
       base: upstreamPrimary,
       body: description.body,
       maintainer_can_modify: maintainersCanModify,
+      draft: draft,
     })
   ).data;
   logger.info(

diff --git a/src/index.ts b/src/index.ts
@@ -179,7 +179,8 @@ async function createPullRequest(
     originBranch,
     description,
     gitHubConfigs.maintainersCanModify,
-    gitHubConfigs.primary
+    gitHubConfigs.primary,
+    options.draft
   );
   logger.info(`Successfully opened pull request: ${prNumber}.`);
 

diff --git a/src/types.ts b/src/types.ts
@@ -97,6 +97,8 @@ export interface CreatePullRequestUserOptions {
   labels?: string[];
   // Number of times to retry if the request fails.  Defaults to 5.
   retry?: number;
+  // Create a DRAFT pull request.
+  draft?: boolean;
 }
 
 /**

diff --git a/test/pr.ts b/test/pr.ts
@@ -86,7 +86,10 @@ describe('Opening a pull request', async () => {
       octokit,
       upstream,
       origin,
-      description
+      description,
+      undefined,
+      undefined,
+      true
     );
     sandbox.assert.calledOnceWithExactly(stub, {
       owner: upstream.owner,
@@ -96,6 +99,7 @@ describe('Opening a pull request', async () => {
       base: 'master',
       body: description.body,
       maintainer_can_modify: true,
+      draft: true,
     });
     assert.strictEqual(number, 1347);
   });
@@ -136,7 +140,15 @@ describe('Opening a pull request', async () => {
         branch: 'new-topic-1',
       };
       // tests
-      await openPullRequest(octokit, upstream, similarOrigin1, description);
+      await openPullRequest(
+        octokit,
+        upstream,
+        similarOrigin1,
+        description,
+        undefined,
+        undefined,
+        false
+      );
       sandbox.assert.calledOnceWithExactly(stub, {
         owner: upstream.owner,
         repo: similarOrigin1.repo,
@@ -145,6 +157,7 @@ describe('Opening a pull request', async () => {
         base: 'master',
         body: description.body,
         maintainer_can_modify: true,
+        draft: false,
       });
     });
 
@@ -170,6 +183,7 @@ describe('Opening a pull request', async () => {
         base: 'master',
         body: description.body,
         maintainer_can_modify: true,
+        draft: false,
       });
     });
 
@@ -196,6 +210,7 @@ describe('Opening a pull request', async () => {
         base: 'master',
         body: description.body,
         maintainer_can_modify: true,
+        draft: false,
       });
     });
 
@@ -221,6 +236,7 @@ describe('Opening a pull request', async () => {
         base: 'master',
         body: description.body,
         maintainer_can_modify: true,
+        draft: false,
       });
     });
   });