Fix github preRelease option (fixes #679)

release-it · Aug 22, 2020 · 49742cb · 49742cb
1 parent ea67fbe
commit 49742cb
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/lib/plugin/github/GitHub.js b/lib/plugin/github/GitHub.js
@@ -169,7 +169,7 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { draft = false, releaseName } = this.options;
+    const { releaseName, draft = false, preRelease = false } = this.options;
     const { version, tagName, releaseNotes } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
@@ -182,7 +182,7 @@ class GitHub extends Release {
       name,
       body,
       draft,
-      prerelease: isPreRelease
+      prerelease: isPreRelease || preRelease
     });
   }
 

diff --git a/test/github.js b/test/github.js
@@ -64,6 +64,34 @@ test('should release and upload assets', async t => {
   exec.restore();
 });
 
+test('should create a pre-release and draft release notes', async t => {
+  const options = {
+    git,
+    github: {
+      pushRepo,
+      tokenRef,
+      release: true,
+      releaseName: 'Release ${tagName}',
+      preRelease: true,
+      draft: true
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git describe --tags --abbrev=0').resolves('2.0.1');
+
+  interceptAuthentication();
+  interceptCollaborator();
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: null, prerelease: true, draft: true } });
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl } = github.getContext();
+  t.true(isReleased);
+  t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2');
+  exec.restore();
+});
+
 test('should update release and upload assets', async t => {
   const asset = 'file1';
   const options = {