feat: options for draft pull requests (#959)

algolia · Sep 20, 2021 · 9556036 · 9556036
1 parent 634e065
commit 9556036
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/packages/shipjs-lib/src/lib/config/defaultConfig.js b/packages/shipjs-lib/src/lib/config/defaultConfig.js
@@ -77,6 +77,7 @@ _This pull request is automatically generated by [Ship.js](https://github.com/al
 `.trim();
  return message;
  },
+ draftPullRequest: false,
  pullRequestReviewers: undefined,
  pullRequestTeamReviewers: undefined,
  shouldRelease: ({

diff --git a/packages/shipjs/src/step/prepare/createPullRequest.js b/packages/shipjs/src/step/prepare/createPullRequest.js
@@ -22,6 +22,7 @@ export default async ({
  formatPullRequestTitle,
  formatPullRequestMessage,
  publishCommand,
+ draftPullRequest,
  pullRequestReviewers,
  pullRequestTeamReviewers,
  remote,
@@ -73,6 +74,7 @@ export default async ({
  body: message,
  head: stagingBranch,
  base: baseBranch,
+ draft: draftPullRequest,
  });
 
  if (

diff --git a/website/reference/all-config.md b/website/reference/all-config.md
@@ -178,6 +178,14 @@ beforeCommitChanges: ({ nextVersion, releaseType, exec, dir }) => {
 
 This is a lifecycle hook which is executed right before `git commit` happens. You can put additional code like modifying some other files.
 
+## `draftPullRequest`
+
+_used at_: `shipjs prepare`
+
+_default:_ `false`
+
+If `true`, Ship.js will create a draft pull request.
+
 ## `pullRequestReviewers`
 
 _used at_: `shipjs prepare`