feat: add support for draft releases

dev-build-deploy · Aug 31, 2023 · b691f1f · b691f1f
1 parent e55ef7f
commit b691f1f
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,7 @@ jobs:
 | `versioning` | NO | [Versioning strategy](#versioning-strategies) to apply. MUST be one of `semver` or `calver`. Default: `semver` |
 | `release-notes` | NO | Path towards a file containing the release notes to include in the GitHub release (Markdown format recommended) |
 | `increment-type` | NO | Enforce a specific increment type, please refer to the [Versioning Strategies](./docs/versioning-strategies.md) for more details |
+| `draft` | NO | Create a GitHub Release in `draft` status |
 
 ## Outputs
 

diff --git a/action.yml b/action.yml
@@ -36,6 +36,11 @@ inputs:
     description: Versioning scheme to apply
     required: false
     default: 'semver'
+
+  draft:
+    description: 'Draft GitHub Release instead of publishing it'
+    required: false
+    default: false
 
   release-notes:
     description: 'External Release Notes file to include in the GitHub Release'

diff --git a/lib/get/index.js b/lib/get/index.js
diff --git a/lib/main/index.js b/lib/main/index.js
diff --git a/src/releasing.ts b/src/releasing.ts
@@ -30,7 +30,7 @@ export async function createRelease(version: versioning.Version, body: string):
     ...github.context.repo,
     name: version.toString(),
     body,
-    draft: false,
+    draft: core.getBooleanInput("draft"),
     prerelease: version instanceof SemVer ? version.preRelease !== undefined : false,
     make_latest: branching.getBranch().type === "default" ? "true" : "false",
     tag_name: version.toString(),