feat: return release informations from publish hook

Author: pvdlg

index.js

@@ -24,7 +24,7 @@ async function publish(pluginConfig, context) {
     await verifyGitHub(pluginConfig, context);
     verified = true;
   }
-  await publishGitHub(pluginConfig, context);
+  return publishGitHub(pluginConfig, context);
 }
 
 module.exports = {verifyConditions, publish};

lib/publish.js

@@ -20,8 +20,8 @@ module.exports = async (pluginConfig, {options: {branch, repositoryUrl}, nextRel
   debug('release name: %o', gitTag);
   debug('release branch: %o', branch);
 
-  const {data: {html_url: htmlUrl, upload_url: uploadUrl}} = await github.repos.createRelease(release);
-  logger.log('Published GitHub release: %s', htmlUrl);
+  const {data: {html_url: url, upload_url: uploadUrl}} = await github.repos.createRelease(release);
+  logger.log('Published GitHub release: %s', url);
 
   if (assets && assets.length > 0) {
     const globbedAssets = await globAssets(assets);
@@ -64,4 +64,6 @@ module.exports = async (pluginConfig, {options: {branch, repositoryUrl}, nextRel
       logger.log('Published file %s', downloadUrl);
     });
   }
+
+  return {url, name: 'GitHub release'};
 };

test/integration.test.js

@@ -147,8 +147,9 @@ test.serial('Publish a release with an array of assets', async t => {
     .post(`${uploadUri}?name=${escape('upload_other.txt')}&label=${escape('Other File')}`)
     .reply(200, {browser_download_url: otherAssetUrl});
 
-  await t.context.m.publish({assets}, {nextRelease, options, logger: t.context.logger});
+  const result = await t.context.m.publish({assets}, {nextRelease, options, logger: t.context.logger});
 
+  t.is(result.url, releaseUrl);
   t.deepEqual(t.context.log.args[0], ['Verify GitHub authentication']);
   t.deepEqual(t.context.log.args[1], ['Published GitHub release: %s', releaseUrl]);
   t.deepEqual(t.context.log.args[2], ['Published file %s', assetUrl]);

test/publish.test.js

@@ -54,8 +54,9 @@ test.serial('Publish a release', async t => {
     })
     .reply(200, {upload_url: uploadUrl, html_url: releaseUrl});
 
-  await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
+  const result = await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
 
+  t.is(result.url, releaseUrl);
   t.deepEqual(t.context.log.args[0], ['Published GitHub release: %s', releaseUrl]);
   t.true(github.isDone());
 });
@@ -91,8 +92,9 @@ test.serial('Publish a release with one asset', async t => {
     .post(`${uploadUri}?name=${escape('.dotfile')}&label=${escape('A dotfile with no ext')}`)
     .reply(200, {browser_download_url: assetUrl});
 
-  await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
+  const result = await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
 
+  t.is(result.url, releaseUrl);
   t.deepEqual(t.context.log.args[0], ['Published GitHub release: %s', releaseUrl]);
   t.deepEqual(t.context.log.args[1], ['Published file %s', assetUrl]);
   t.true(github.isDone());
@@ -139,8 +141,9 @@ test.serial('Publish a release with one asset and custom github url', async t =>
     .post(`${uploadUri}?name=${escape('upload.txt')}&label=${escape('A text file')}`)
     .reply(200, {browser_download_url: assetUrl});
 
-  await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
+  const result = await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
 
+  t.is(result.url, releaseUrl);
   t.deepEqual(t.context.log.args[0], ['Published GitHub release: %s', releaseUrl]);
   t.deepEqual(t.context.log.args[1], ['Published file %s', assetUrl]);
   t.true(github.isDone());
@@ -169,8 +172,9 @@ test.serial('Publish a release with an array of missing assets', async t => {
     })
     .reply(200, {upload_url: uploadUrl, html_url: releaseUrl});
 
-  await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
+  const result = await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
 
+  t.is(result.url, releaseUrl);
   t.deepEqual(t.context.log.args[0], ['Published GitHub release: %s', releaseUrl]);
   t.deepEqual(t.context.error.args[0], [
     'The asset %s cannot be read, and will be ignored.',