fix: return the url of the final release rather than the url the draft (#214)

Fixes #212

Author: michael-wolfenden

lib/publish.js

@@ -50,7 +50,7 @@ module.exports = async (pluginConfig, context) => {
   const draftRelease = {...releaseData, draft: true};
 
   const {
-    data: {html_url: url, upload_url: uploadUrl, id: releaseId},
+    data: {upload_url: uploadUrl, id: releaseId},
   } = await github.repos.createRelease(draftRelease);
 
   // Append assets to the release
@@ -108,7 +108,9 @@ module.exports = async (pluginConfig, context) => {
   };
   /* eslint-enable */
 
-  await github.repos.updateRelease(release);
+  const {
+    data: {html_url: url},
+  } = await github.repos.updateRelease(release);
 
   logger.log('Published GitHub release: %s', url);
   return {url, name: 'GitHub release'};

test/publish.test.js

@@ -101,6 +101,7 @@ test.serial('Publish a release with one asset', async t => {
   };
   const nextRelease = {version: '1.0.0', gitHead: '123', gitTag: 'v1.0.0', notes: 'Test release note body'};
   const options = {branch: 'master', repositoryUrl: `https://github.com/${owner}/${repo}.git`};
+  const untaggedReleaseUrl = `https://github.com/${owner}/${repo}/releases/untagged-123`;
   const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
   const assetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/.dotfile`;
   const releaseId = 1;
@@ -115,7 +116,7 @@ test.serial('Publish a release with one asset', async t => {
       body: nextRelease.notes,
       draft: true,
     })
-    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl, id: releaseId})
+    .reply(200, {upload_url: uploadUrl, html_url: untaggedReleaseUrl, id: releaseId})
     .patch(`/repos/${owner}/${repo}/releases/${releaseId}`, {
       draft: false,
     })
@@ -146,6 +147,7 @@ test.serial('Publish a release with one asset and custom github url', async t =>
   };
   const nextRelease = {version: '1.0.0', gitHead: '123', gitTag: 'v1.0.0', notes: 'Test release note body'};
   const options = {branch: 'master', repositoryUrl: `https://github.com/${owner}/${repo}.git`};
+  const untaggedReleaseUrl = `${env.GH_URL}/${owner}/${repo}/releases/untagged-123`;
   const releaseUrl = `${env.GH_URL}/${owner}/${repo}/releases/${nextRelease.version}`;
   const assetUrl = `${env.GH_URL}/${owner}/${repo}/releases/download/${nextRelease.version}/upload.txt`;
   const releaseId = 1;
@@ -160,7 +162,7 @@ test.serial('Publish a release with one asset and custom github url', async t =>
       body: nextRelease.notes,
       draft: true,
     })
-    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl, id: releaseId})
+    .reply(200, {upload_url: uploadUrl, html_url: untaggedReleaseUrl, id: releaseId})
     .patch(`/repos/${owner}/${repo}/releases/${releaseId}`, {
       draft: false,
     })
@@ -190,6 +192,7 @@ test.serial('Publish a release with an array of missing assets', async t => {
   const pluginConfig = {assets: [emptyDirectory, {path: 'missing.txt', name: 'missing.txt'}]};
   const nextRelease = {version: '1.0.0', gitHead: '123', gitTag: 'v1.0.0', notes: 'Test release note body'};
   const options = {branch: 'master', repositoryUrl: `https://github.com/${owner}/${repo}.git`};
+  const untaggedReleaseUrl = `https://github.com/${owner}/${repo}/releases/untagged-123`;
   const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
   const releaseId = 1;
   const uploadUri = `/api/uploads/repos/${owner}/${repo}/releases/${releaseId}/assets`;
@@ -203,7 +206,7 @@ test.serial('Publish a release with an array of missing assets', async t => {
       body: nextRelease.notes,
       draft: true,
     })
-    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl, id: releaseId})
+    .reply(200, {upload_url: uploadUrl, html_url: untaggedReleaseUrl, id: releaseId})
     .patch(`/repos/${owner}/${repo}/releases/${releaseId}`, {
       draft: false,
     })