@semantic-release/github 7.0.7 → 7.2.0

package/README.md

@@ -3,9 +3,7 @@
 [**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a
 [GitHub release](https://help.github.com/articles/about-releases) and comment on released Pull Requests/Issues.
 
-[![Travis](https://img.shields.io/travis/semantic-release/github.svg)](https://travis-ci.org/semantic-release/github)
-[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/github.svg)](https://codecov.io/gh/semantic-release/github)
-[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/github.svg)](https://greenkeeper.io/)
+[![Build Status](https://github.com/semantic-release/github/workflows/Test/badge.svg)](https://github.com/semantic-release/github/actions?query=workflow%3ATest+branch%3Amaster)
 
 [![npm latest version](https://img.shields.io/npm/v/@semantic-release/github/latest.svg)](https://www.npmjs.com/package/@semantic-release/github)
 [![npm next version](https://img.shields.io/npm/v/@semantic-release/github/next.svg)](https://www.npmjs.com/package/@semantic-release/github)
@@ -83,7 +81,8 @@ If you have actions that trigger on newly created releases, please use a generat
 | `failTitle`           | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.                                                                                  | `The automated release is failing 🚨`                                                                                                                |
 | `labels`              | The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.                                                     | `['semantic-release']`                                                                                                                               |
 | `assignees`           | The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.                                           | -                                                                                                                                                    |
-| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']`                                                                     |
+| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']-                                                                                                                                                    |
+| `addReleases`         | Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See [addReleases](#addReleases). | `false`                                                                     |
 
 #### proxy
 
@@ -204,3 +203,13 @@ Each label name is generated with [Lodash template](https://lodash.com/docs#temp
 The `releasedLabels` ```['released<%= nextRelease.channel ? ` on @\${nextRelease.channel}` : "" %> from <%= branch.name %>']``` will generate the label:
 
 > released on @next from branch next
+
+#### addReleases
+
+Add links to other releases to the GitHub release body.
+
+Valid values for this option are `false`, `"top"` or `"bottom"`.
+
+##### addReleases example
+
+See [The introducing PR](https://github.com/semantic-release/github/pull/282) for an example on how it will look.

package/lib/definitions/errors.js

@@ -57,6 +57,12 @@ Your configuration for the \`assignees\` option is \`${stringify(assignees)}\`.`
     )}) if defined, must be an \`Array\` of non empty \`String\`.
 
 Your configuration for the \`releasedLabels\` option is \`${stringify(releasedLabels)}\`.`,
+  }),
+  EINVALIDADDRELEASES: ({addReleases}) => ({
+    message: 'Invalid `addReleases` option.',
+    details: `The [addReleases option](${linkify('README.md#options')}) if defined, must be one of \`false|top|bottom\`.
+
+Your configuration for the \`addReleases\` option is \`${stringify(addReleases)}\`.`,
   }),
   EINVALIDGITHUBURL: () => ({
     message: 'The git repository URL is not a valid GitHub URL.',

package/lib/get-release-links.js

@@ -0,0 +1,22 @@
+const {RELEASE_NAME} = require('./definitions/constants');
+
+const linkify = (releaseInfo) =>
+  `${
+    releaseInfo.url
+      ? releaseInfo.url.startsWith('http')
+        ? `[${releaseInfo.name}](${releaseInfo.url})`
+        : `${releaseInfo.name}: \`${releaseInfo.url}\``
+      : `\`${releaseInfo.name}\``
+  }`;
+
+const filterReleases = (releaseInfos) =>
+  releaseInfos.filter((releaseInfo) => releaseInfo.name && releaseInfo.name !== RELEASE_NAME);
+
+module.exports = (releaseInfos) =>
+  `${
+    filterReleases(releaseInfos).length > 0
+      ? `This release is also available on:\n${filterReleases(releaseInfos)
+          .map((releaseInfo) => `- ${linkify(releaseInfo)}`)
+          .join('\n')}`
+      : ''
+  }`;

package/lib/glob-assets.js

@@ -1,5 +1,4 @@
 const path = require('path');
-const {basename} = require('path');
 const {isPlainObject, castArray, uniqWith, uniq} = require('lodash');
 const dirGlob = require('dir-glob');
 const globby = require('globby');
@@ -40,7 +39,7 @@ module.exports = async ({cwd}, assets) =>
                 // - `path` of the matched file
                 // - `name` based on the actual file name (to avoid assets with duplicate `name`)
                 // - other properties of the original asset definition
-                return globbed.map((file) => ({...asset, path: file, name: basename(file)}));
+                return globbed.map((file) => ({...asset, path: file, name: path.basename(file)}));
               }
 
               // If asset is an Object, output an Object definition with:

package/lib/parse-github-url.js

@@ -5,7 +5,7 @@ module.exports = (repositoryUrl) => {
       new URL(match ? `ssh://${auth ? `${auth}@` : ''}${host}/${path}` : repositoryUrl).pathname
     );
     return {owner, repo};
-  } catch (_) {
+  } catch {
     return {};
   }
 };

package/lib/publish.js

@@ -1,4 +1,4 @@
-const {basename, extname, resolve} = require('path');
+const path = require('path');
 const {stat, readFile} = require('fs-extra');
 const {isPlainObject, template} = require('lodash');
 const mime = require('mime');
@@ -21,18 +21,26 @@ module.exports = async (pluginConfig, context) => {
   const {githubToken, githubUrl, githubApiPathPrefix, proxy, assets} = resolveConfig(pluginConfig, context);
   const {owner, repo} = parseGithubUrl(repositoryUrl);
   const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
-  const release = {owner, repo, tag_name: gitTag, name, body: notes, prerelease: isPrerelease(branch)};
+  const release = {
+    owner,
+    repo,
+    tag_name: gitTag,
+    target_commitish: branch.name,
+    name,
+    body: notes,
+    prerelease: isPrerelease(branch),
+  };
 
   debug('release object: %O', release);
 
   // When there are no assets, we publish a release directly
   if (!assets || assets.length === 0) {
     const {
-      data: {html_url: url},
+      data: {html_url: url, id: releaseId},
     } = await github.repos.createRelease(release);
 
     logger.log('Published GitHub release: %s', url);
-    return {url, name: RELEASE_NAME};
+    return {url, name: RELEASE_NAME, id: releaseId};
   }
 
   // We'll create a draft release, append the assets to it, and then publish it.
@@ -53,8 +61,8 @@ module.exports = async (pluginConfig, context) => {
       let file;
 
       try {
-        file = await stat(resolve(cwd, filePath));
-      } catch (_) {
+        file = await stat(path.resolve(cwd, filePath));
+      } catch {
         logger.error('The asset %s cannot be read, and will be ignored.', filePath);
         return;
       }
@@ -64,13 +72,13 @@ module.exports = async (pluginConfig, context) => {
         return;
       }
 
-      const fileName = template(asset.name || basename(filePath))(context);
+      const fileName = template(asset.name || path.basename(filePath))(context);
       const upload = {
         url: uploadUrl,
-        data: await readFile(resolve(cwd, filePath)),
+        data: await readFile(path.resolve(cwd, filePath)),
         name: fileName,
         headers: {
-          'content-type': mime.getType(extname(fileName)) || 'text/plain',
+          'content-type': mime.getType(path.extname(fileName)) || 'text/plain',
           'content-length': file.size,
         },
       };
@@ -94,5 +102,5 @@ module.exports = async (pluginConfig, context) => {
   } = await github.repos.updateRelease({owner, repo, release_id: releaseId, draft: false});
 
   logger.log('Published GitHub release: %s', url);
-  return {url, name: RELEASE_NAME};
+  return {url, name: RELEASE_NAME, id: releaseId};
 };

package/lib/resolve-config.js

@@ -12,6 +12,7 @@ module.exports = (
     labels,
     assignees,
     releasedLabels,
+    addReleases,
   },
   {env}
 ) => ({
@@ -30,4 +31,5 @@ module.exports = (
     : releasedLabels === false
     ? false
     : castArray(releasedLabels),
+  addReleases: isNil(addReleases) ? false : addReleases,
 });

package/lib/success.js

@@ -1,4 +1,4 @@
-const {isNil, uniqBy, template, flatten} = require('lodash');
+const {isNil, uniqBy, template, flatten, isEmpty} = require('lodash');
 const pFilter = require('p-filter');
 const AggregateError = require('aggregate-error');
 const issueParser = require('issue-parser');
@@ -9,6 +9,8 @@ const getClient = require('./get-client');
 const getSearchQueries = require('./get-search-queries');
 const getSuccessComment = require('./get-success-comment');
 const findSRIssues = require('./find-sr-issues');
+const {RELEASE_NAME} = require('./definitions/constants');
+const getReleaseLinks = require('./get-release-links');
 
 module.exports = async (pluginConfig, context) => {
   const {
@@ -27,6 +29,7 @@ module.exports = async (pluginConfig, context) => {
     failComment,
     failTitle,
     releasedLabels,
+    addReleases,
   } = resolveConfig(pluginConfig, context);
 
   const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
@@ -140,6 +143,21 @@ module.exports = async (pluginConfig, context) => {
     );
   }
 
+  if (addReleases !== false && errors.length === 0) {
+    const ghRelease = releases.find((release) => release.name && release.name === RELEASE_NAME);
+    if (!isNil(ghRelease)) {
+      const ghRelaseId = ghRelease.id;
+      const additionalReleases = getReleaseLinks(releases);
+      if (!isEmpty(additionalReleases) && !isNil(ghRelaseId)) {
+        const newBody =
+          addReleases === 'top'
+            ? additionalReleases.concat('\n---\n', nextRelease.notes)
+            : nextRelease.notes.concat('\n---\n', additionalReleases);
+        await github.repos.updateRelease({owner, repo, release_id: ghRelaseId, body: newBody});
+      }
+    }
+  }
+
   if (errors.length > 0) {
     throw new AggregateError(errors);
   }

package/lib/verify.js

@@ -7,6 +7,7 @@ const getClient = require('./get-client');
 const getError = require('./get-error');
 
 const isNonEmptyString = (value) => isString(value) && value.trim();
+const oneOf = (enumArray) => (value) => enumArray.some((element) => element === value);
 const isStringOrStringArray = (value) =>
   isNonEmptyString(value) || (isArray(value) && value.every((string) => isNonEmptyString(string)));
 const isArrayOf = (validator) => (array) => isArray(array) && array.every((value) => validator(value));
@@ -24,6 +25,7 @@ const VALIDATORS = {
   labels: canBeDisabled(isArrayOf(isNonEmptyString)),
   assignees: isArrayOf(isNonEmptyString),
   releasedLabels: canBeDisabled(isArrayOf(isNonEmptyString)),
+  addReleases: canBeDisabled(oneOf(['bottom', 'top'])),
 };
 
 module.exports = async (pluginConfig, context) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/github",
   "description": "semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues",
-  "version": "7.0.7",
+  "version": "7.2.0",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "ava": {
     "files": [
@@ -16,7 +16,7 @@
     "Gregor Martynus (https://twitter.com/gr2m)"
   ],
   "dependencies": {
-    "@octokit/rest": "^17.0.0",
+    "@octokit/rest": "^18.0.0",
     "@semantic-release/error": "^2.2.0",
     "aggregate-error": "^3.0.0",
     "bottleneck": "^2.18.1",
@@ -34,18 +34,18 @@
     "url-join": "^4.0.0"
   },
   "devDependencies": {
-    "ava": "^3.1.0",
-    "clear-module": "^4.0.0",
-    "codecov": "^3.5.0",
-    "nock": "^12.0.0",
-    "nyc": "^15.0.0",
-    "proxy": "^1.0.0",
-    "proxyquire": "^2.0.0",
-    "semantic-release": "^17.0.0",
-    "server-destroy": "^1.0.1",
-    "sinon": "^9.0.0",
-    "tempy": "^0.5.0",
-    "xo": "^0.30.0"
+    "ava": "3.13.0",
+    "clear-module": "4.1.1",
+    "codecov": "3.8.1",
+    "nock": "13.0.5",
+    "nyc": "15.1.0",
+    "proxy": "1.0.2",
+    "proxyquire": "2.1.3",
+    "semantic-release": "17.2.3",
+    "server-destroy": "1.0.1",
+    "sinon": "9.2.1",
+    "tempy": "1.0.0",
+    "xo": "0.34.2"
   },
   "engines": {
     "node": ">=10.18"
@@ -99,7 +99,8 @@
     "lint": "xo",
     "pretest": "npm run lint",
     "semantic-release": "semantic-release",
-    "test": "nyc ava -v"
+    "test": "nyc ava -v",
+    "test:ci": "nyc ava -v"
   },
   "xo": {
     "prettier": true,
@@ -111,7 +112,13 @@
           "properties": "never"
         }
       ],
-      "unicorn/string-content": "off"
+      "unicorn/string-content": "off",
+      "unicorn/no-reduce": "off"
     }
+  },
+  "renovate": {
+    "extends": [
+      "github>semantic-release/.github"
+    ]
   }
 }