feat: add option to create release PR as draft (#42)

* feat: add option to create PR as draft

* chore: fix linting

* chore: bump ncc

package.json

@@ -37,7 +37,7 @@
     "@types/node": "^18.6.3",
     "@typescript-eslint/eslint-plugin": "^5.21.0",
     "@typescript-eslint/parser": "^5.21.0",
-    "@vercel/ncc": "^0.34.0",
+    "@vercel/ncc": "^0.38.1",
     "eslint": "^8.56.0",
     "eslint-import-resolver-typescript": "^2.7.1",
     "husky": "^8.0.3",

src/constants.ts

@@ -6,6 +6,7 @@ export enum Input {
   VersionExtraArgs = 'version-extra-args',
   VersionStrategy = 'version-strategy',
   AutoMerge = 'auto-merge',
+  Draft = 'draft',
   RequestReviewers = 'request-reviewers',
   DefaultBranch = 'default-branch',
 }

src/utils/github.ts

@@ -25,6 +25,7 @@ type CreatePullRequestsParams = {
   body?: string
   labels?: string[]
   autoMerge?: boolean
+  draft?: boolean
   reviewers?: string[]
 }
 
@@ -38,6 +39,7 @@ export async function createPullRequest({
   labels,
   assignees,
   autoMerge,
+  draft,
   reviewers,
 }: CreatePullRequestsParams) {
   core.debug(`Creating pull request in ${repo.owner}/${repo.owner} with base branch ${base}`)
@@ -47,6 +49,7 @@ export async function createPullRequest({
     head,
     base,
     body,
+    draft,
   })
 
   const promises = []

src/version.ts

@@ -25,6 +25,7 @@ import { assertStrategy, validateAllowedStrategies, VersionStrategy } from './ve
 import updateChangelog from './version/update-changelog'
 import closePreviousPrs from './version/close-previous-prs'
 import { unwrapErrorMessage } from './utils/errors'
+import * as assert from 'assert'
 
 if (require.main === module) {
   version().catch((error: Error) => {
@@ -41,11 +42,16 @@ export default async function version({
   token = core.getInput(Input.GithubToken, { required: true }),
   versionExtraArgs = core.getInput(Input.VersionExtraArgs),
   versionStrategy = core.getInput(Input.VersionStrategy),
-  autoMerge = core.getInput(Input.AutoMerge) === 'true',
-  requestReviewers = core.getInput(Input.RequestReviewers) === 'true',
+  autoMerge = core.getBooleanInput(Input.AutoMerge),
+  draft = core.getBooleanInput(Input.Draft),
+  requestReviewers = core.getBooleanInput(Input.RequestReviewers),
   assignee = core.getInput(Input.Assignee),
 } = {}) {
   assertStrategy(versionStrategy)
+  assert(
+    !(draft && autoMerge),
+    'A pull-request can either be created as draft, or with auto-merge enabled, but not both at the same time.'
+  )
 
   const { actor, repo } = github.context
   assignee = assignee || actor
@@ -113,6 +119,7 @@ export default async function version({
   core.info('Creating PR')
   const pullRequest = await createPullRequest({
     client,
+    draft,
     base: defaultBranch,
     repo,
     packages,

src/version/create-pull-request.ts

@@ -13,6 +13,7 @@ type Params = {
   labels?: string[]
   assignees?: string[]
   autoMerge?: boolean
+  draft?: boolean
   requestReviewers?: boolean
 }
 
@@ -26,6 +27,7 @@ export default async function createPullRequest({
   labels,
   assignees,
   autoMerge,
+  draft,
   requestReviewers,
 }: Params) {
   const packageNames = packages.map((it) => path.basename(it))
@@ -45,6 +47,7 @@ export default async function createPullRequest({
     labels,
     assignees,
     autoMerge,
+    draft,
     reviewers: requestReviewers ? assignees : undefined,
   })
 }

version/action.yml

@@ -20,6 +20,9 @@ inputs:
   request-reviewers:
     description: 'Request PR assignees as reviewers'
     default: true
+  draft:
+    description: 'Creates the release PR as draft'
+    default: false
 
 runs:
   using: 'node20'

yarn.lock

@@ -719,7 +719,7 @@ __metadata:
     "@types/node": ^18.6.3
     "@typescript-eslint/eslint-plugin": ^5.21.0
     "@typescript-eslint/parser": ^5.21.0
-    "@vercel/ncc": ^0.34.0
+    "@vercel/ncc": ^0.38.1
     conventional-changelog-conventionalcommits: ^5.0.0
     conventional-changelog-core: ^4.2.4
     eslint: ^8.56.0
@@ -1793,14 +1793,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@vercel/ncc@npm:^0.34.0":
-  version: 0.34.0
-  resolution: "@vercel/ncc@npm:0.34.0"
+"@vercel/ncc@npm:^0.38.1":
+  version: 0.38.1
+  resolution: "@vercel/ncc@npm:0.38.1"
   dependencies:
     node-gyp: latest
   bin:
     ncc: dist/ncc/cli.js
-  checksum: 3282578e990572759454f7f8d7ef025f2ae060b261fcb28a96d165350e3665438dc8fb72caf122081d6c57277e4899dab30ea0d8759bfd90baf37286cb887597
+  checksum: a522bb44c25a65db89941b08ca5817794b6920052f09a9cbd202cc987b81c13dd48cad9aa3b06793fc47ef70ae87fa0b85caf5b6a73e95de8091818049ed6194
   languageName: node
   linkType: hard