From c100af8511d5f5500b71038f1457c56c5b657734 Mon Sep 17 00:00:00 2001 From: lulzneko Date: Mon, 20 Sep 2021 19:35:46 +0900 Subject: [PATCH] feat: options for draft pull requests --- packages/shipjs-lib/src/lib/config/defaultConfig.js | 1 + packages/shipjs/src/step/prepare/createPullRequest.js | 2 ++ website/reference/all-config.md | 8 ++++++++ 3 files changed, 11 insertions(+) diff --git a/packages/shipjs-lib/src/lib/config/defaultConfig.js b/packages/shipjs-lib/src/lib/config/defaultConfig.js index dbff2bb61..3b297347d 100644 --- 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 index f1306af32..994bcdc0b 100644 --- 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 index 92423b71c..9bee540b3 100644 --- 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`