@semantic-release/github 7.0.5 → 7.1.1

package/README.md

@@ -59,13 +59,16 @@ When creating the token, the **minimum required scopes** are:
 - [`repo`](https://github.com/settings/tokens/new?scopes=repo) for a private repository
 - [`public_repo`](https://github.com/settings/tokens/new?scopes=public_repo) for a public repository
 
+_Note on GitHub Actions:_ You can use the default token which is provided in  the secret _GITHUB_TOKEN_. However releases done with this token will NOT trigger release events to start other workflows.
+If you have actions that trigger on newly created releases, please use a generated token for that and store it in your repository's secrets (any other name than GITHUB_TOKEN is fine).
+
 ### Environment variables
 
-| Variable                       | Description                                               |
-| ------------------------------ | --------------------------------------------------------- |
-| `GH_TOKEN` or `GITHUB_TOKEN`   | **Required.** The token used to authenticate with GitHub. |
-| `GH_URL` or `GITHUB_URL`       | The GitHub Enterprise endpoint.                           |
-| `GH_PREFIX` or `GITHUB_PREFIX` | The GitHub Enterprise API prefix.                         |
+| Variable                                           | Description                                               |
+| -------------------------------------------------- | --------------------------------------------------------- |
+| `GH_TOKEN` or `GITHUB_TOKEN`                       | **Required.** The token used to authenticate with GitHub. |
+| `GITHUB_API_URL` or `GH_URL` or `GITHUB_URL`       | The GitHub Enterprise endpoint.                           |
+| `GH_PREFIX` or `GITHUB_PREFIX`                     | The GitHub Enterprise API prefix.                         |
 
 ### Options
 
@@ -80,7 +83,8 @@ When creating the token, the **minimum required scopes** are:
 | `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
 
@@ -201,3 +205,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/index.js

@@ -14,7 +14,7 @@ async function verifyConditions(pluginConfig, context) {
   // If the GitHub publish plugin is used and has `assets`, `successComment`, `failComment`, `failTitle`, `labels` or `assignees` configured, validate it now in order to prevent any release if the configuration is wrong
   if (options.publish) {
     const publishPlugin =
-      castArray(options.publish).find(config => config.path && config.path === '@semantic-release/github') || {};
+      castArray(options.publish).find((config) => config.path && config.path === '@semantic-release/github') || {};
 
     pluginConfig.assets = defaultTo(pluginConfig.assets, publishPlugin.assets);
     pluginConfig.successComment = defaultTo(pluginConfig.successComment, publishPlugin.successComment);

package/lib/definitions/errors.js

@@ -3,9 +3,9 @@ const {isString} = require('lodash');
 const pkg = require('../../package.json');
 
 const [homepage] = pkg.homepage.split('#');
-const stringify = object =>
+const stringify = (object) =>
   isString(object) ? object : inspect(object, {breakLength: Infinity, depth: 2, maxArrayLength: 5});
-const linkify = file => `${homepage}/blob/master/${file}`;
+const linkify = (file) => `${homepage}/blob/master/${file}`;
 
 module.exports = {
   EINVALIDASSETS: ({assets}) => ({
@@ -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.',
@@ -73,7 +79,7 @@ By default the \`repositoryUrl\` option is retrieved from the \`repository\` pro
 Your configuration for the \`proxy\` option is \`${stringify(proxy)}\`.`,
   }),
   EMISSINGREPO: ({owner, repo}) => ({
-    message: `The repository ${owner}/${repo} doesn’t exist.`,
+    message: `The repository ${owner}/${repo} doesn't exist.`,
     details: `The **semantic-release** \`repositoryUrl\` option must refer to your GitHub repository. The repository must be accessible with the [GitHub API](https://developer.github.com/v3).
 
 By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.
@@ -83,7 +89,7 @@ If you are using [GitHub Enterprise](https://enterprise.github.com) please make
     )}).`,
   }),
   EGHNOPERMISSION: ({owner, repo}) => ({
-    message: `The GitHub token doesn’t allow to push on the repository ${owner}/${repo}.`,
+    message: `The GitHub token doesn't allow to push on the repository ${owner}/${repo}.`,
     details: `The user associated with the [GitHub token](${linkify(
       'README.md#github-authentication'
     )}) configured in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable must allows to push to the repository ${owner}/${repo}.

package/lib/find-sr-issues.js

@@ -7,5 +7,5 @@ module.exports = async (github, title, owner, repo) => {
     q: `in:title+repo:${owner}/${repo}+type:issue+state:open+${title}`,
   });
 
-  return issues.filter(issue => issue.body && issue.body.includes(ISSUE_ID));
+  return issues.filter((issue) => issue.body && issue.body.includes(ISSUE_ID));
 };

package/lib/get-client.js

@@ -11,7 +11,7 @@ const {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} = require('./definitions/rate
 /**
  * Http error status for which to not retry.
  */
-const SKIP_RETRY_CODES = [400, 401, 403];
+const SKIP_RETRY_CODES = new Set([400, 401, 403]);
 
 /**
  * Create or retrieve the throttler function for a given rate limit group.
@@ -50,7 +50,7 @@ module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
       try {
         return await getThrottler(limitKey, globalThrottler).wrap(request)(options);
       } catch (error) {
-        if (SKIP_RETRY_CODES.includes(error.status)) {
+        if (SKIP_RETRY_CODES.has(error.status)) {
           throw new pRetry.AbortError(error);
         }
 

package/lib/get-fail-comment.js

@@ -4,14 +4,16 @@ const GET_HELP_URL = `${HOME_URL}#get-help`;
 const USAGE_DOC_URL = `${HOME_URL}/blob/caribou/docs/usage/README.md`;
 const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
 
-const formatError = error => `### ${error.message}
+const formatError = (error) => `### ${error.message}
 
-${error.details ||
-  `Unfortunately this error doesn’t have any additional information.${
+${
+  error.details ||
+  `Unfortunately this error doesn't have any additional information.${
     error.pluginName
       ? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful information.`
       : ''
-  }`}`;
+  }`
+}`;
 
 module.exports = (branch, errors) => `## :rotating_light: The automated release from the \`${
   branch.name
@@ -36,7 +38,7 @@ If those don’t help, or if this issue is reporting something you think isn’t
 
 ---
 
-${errors.map(formatError).join('\n\n---\n\n')}
+${errors.map((error) => formatError(error)).join('\n\n---\n\n')}
 
 ---
 

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/get-success-comment.js

@@ -1,5 +1,5 @@
 const HOME_URL = 'https://github.com/semantic-release/semantic-release';
-const linkify = releaseInfo =>
+const linkify = (releaseInfo) =>
   `${releaseInfo.url ? `[${releaseInfo.name}](${releaseInfo.url})` : `\`${releaseInfo.name}\``}`;
 
 module.exports = (issue, releaseInfos, nextRelease) =>
@@ -10,7 +10,7 @@ module.exports = (issue, releaseInfos, nextRelease) =>
       ? `\n\nThe release is available on${
           releaseInfos.length === 1
             ? ` ${linkify(releaseInfos[0])}`
-            : `:\n${releaseInfos.map(releaseInfo => `- ${linkify(releaseInfo)}`).join('\n')}`
+            : `:\n${releaseInfos.map((releaseInfo) => `- ${linkify(releaseInfo)}`).join('\n')}`
         }`
       : ''
   }

package/lib/glob-assets.js

@@ -10,7 +10,7 @@ module.exports = async ({cwd}, assets) =>
     []
       .concat(
         ...(await Promise.all(
-          assets.map(async asset => {
+          assets.map(async (asset) => {
             // Wrap single glob definition in Array
             let glob = castArray(isPlainObject(asset) ? asset.path : asset);
             // TODO Temporary workaround for https://github.com/mrmlnc/fast-glob/issues/47
@@ -40,7 +40,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: basename(file)}));
               }
 
               // If asset is an Object, output an Object definition with:
@@ -60,7 +60,7 @@ module.exports = async ({cwd}, assets) =>
           // Sort with Object first, to prioritize Object definition over Strings in dedup
         ))
       )
-      .sort(asset => (isPlainObject(asset) ? -1 : 1)),
+      .sort((asset) => (isPlainObject(asset) ? -1 : 1)),
     // Compare `path` property if Object definition, value itself if String
     (a, b) => path.resolve(cwd, isPlainObject(a) ? a.path : a) === path.resolve(cwd, isPlainObject(b) ? b.path : b)
   );

package/lib/parse-github-url.js

@@ -1,4 +1,4 @@
-module.exports = repositoryUrl => {
+module.exports = (repositoryUrl) => {
   const [match, auth, host, path] = /^(?!.+:\/\/)(?:(?<auth>.*)@)?(?<host>.*?):(?<path>.*)$/.exec(repositoryUrl) || [];
   try {
     const [, owner, repo] = /^\/(?<owner>[^/]+)?\/?(?<repo>.+?)(?:\.git)?$/.exec(

package/lib/publish.js

@@ -28,11 +28,11 @@ module.exports = async (pluginConfig, context) => {
   // 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.
@@ -48,7 +48,7 @@ module.exports = async (pluginConfig, context) => {
   debug('globed assets: %o', globbedAssets);
 
   await Promise.all(
-    globbedAssets.map(async asset => {
+    globbedAssets.map(async (asset) => {
       const filePath = isPlainObject(asset) ? asset.path : asset;
       let file;
 
@@ -94,5 +94,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,11 +12,12 @@ module.exports = (
     labels,
     assignees,
     releasedLabels,
+    addReleases,
   },
   {env}
 ) => ({
   githubToken: env.GH_TOKEN || env.GITHUB_TOKEN,
-  githubUrl: githubUrl || env.GH_URL || env.GITHUB_URL,
+  githubUrl: githubUrl || env.GITHUB_API_URL || env.GH_URL || env.GITHUB_URL,
   githubApiPathPrefix: githubApiPathPrefix || env.GH_PREFIX || env.GITHUB_PREFIX || '',
   proxy: proxy || env.HTTP_PROXY,
   assets: assets ? castArray(assets) : assets,
@@ -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});
@@ -39,11 +42,11 @@ module.exports = async (pluginConfig, context) => {
     logger.log('Skip commenting on issues and pull requests.');
   } else {
     const parser = issueParser('github', githubUrl ? {hosts: [githubUrl]} : {});
-    const releaseInfos = releases.filter(release => Boolean(release.name));
+    const releaseInfos = releases.filter((release) => Boolean(release.name));
     const shas = commits.map(({hash}) => hash);
 
     const searchQueries = getSearchQueries(`repo:${owner}/${repo}+type:pr+is:merged`, shas).map(
-      async q => (await github.search.issuesAndPullRequests({q})).data.items
+      async (q) => (await github.search.issuesAndPullRequests({q})).data.items
     );
 
     const prs = await pFilter(
@@ -55,24 +58,27 @@ module.exports = async (pluginConfig, context) => {
 
     debug(
       'found pull requests: %O',
-      prs.map(pr => pr.number)
+      prs.map((pr) => pr.number)
     );
 
     // Parse the release commits message and PRs body to find resolved issues/PRs via comment keyworkds
-    const issues = [...prs.map(pr => pr.body), ...commits.map(commit => commit.message)].reduce((issues, message) => {
-      return message
-        ? issues.concat(
-            parser(message)
-              .actions.close.filter(action => isNil(action.slug) || action.slug === `${owner}/${repo}`)
-              .map(action => ({number: parseInt(action.issue, 10)}))
-          )
-        : issues;
-    }, []);
+    const issues = [...prs.map((pr) => pr.body), ...commits.map((commit) => commit.message)].reduce(
+      (issues, message) => {
+        return message
+          ? issues.concat(
+              parser(message)
+                .actions.close.filter((action) => isNil(action.slug) || action.slug === `${owner}/${repo}`)
+                .map((action) => ({number: Number.parseInt(action.issue, 10)}))
+            )
+          : issues;
+      },
+      []
+    );
 
     debug('found issues via comments: %O', issues);
 
     await Promise.all(
-      uniqBy([...prs, ...issues], 'number').map(async issue => {
+      uniqBy([...prs, ...issues], 'number').map(async (issue) => {
         const body = successComment
           ? template(successComment)({...context, issue})
           : getSuccessComment(issue, releaseInfos, nextRelease);
@@ -85,7 +91,7 @@ module.exports = async (pluginConfig, context) => {
           logger.log('Added comment to issue #%d: %s', issue.number, url);
 
           if (releasedLabels) {
-            const labels = releasedLabels.map(label => template(label)(context));
+            const labels = releasedLabels.map((label) => template(label)(context));
             // Don’t use .issues.addLabels for GHE < 2.16 support
             // https://github.com/semantic-release/github/issues/138
             await github.request('POST /repos/:owner/:repo/issues/:number/labels', {
@@ -100,7 +106,7 @@ module.exports = async (pluginConfig, context) => {
           if (error.status === 403) {
             logger.error('Not allowed to add a comment to the issue #%d.', issue.number);
           } else if (error.status === 404) {
-            logger.error('Failed to add a comment to the issue #%d as it doesn’t exist.', issue.number);
+            logger.error("Failed to add a comment to the issue #%d as it doesn't exist.", issue.number);
           } else {
             errors.push(error);
             logger.error('Failed to add a comment to the issue #%d.', issue.number);
@@ -119,7 +125,7 @@ module.exports = async (pluginConfig, context) => {
     debug('found semantic-release issues: %O', srIssues);
 
     await Promise.all(
-      srIssues.map(async issue => {
+      srIssues.map(async (issue) => {
         debug('close issue: %O', issue);
         try {
           const updateIssue = {owner, repo, issue_number: issue.number, state: 'closed'};
@@ -137,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

@@ -6,16 +6,18 @@ const resolveConfig = require('./resolve-config');
 const getClient = require('./get-client');
 const getError = require('./get-error');
 
-const isNonEmptyString = value => isString(value) && value.trim();
-const isStringOrStringArray = value => isNonEmptyString(value) || (isArray(value) && value.every(isNonEmptyString));
-const isArrayOf = validator => array => isArray(array) && array.every(value => validator(value));
-const canBeDisabled = validator => value => value === false || validator(value);
+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));
+const canBeDisabled = (validator) => (value) => value === false || validator(value);
 
 const VALIDATORS = {
-  proxy: proxy =>
+  proxy: (proxy) =>
     isNonEmptyString(proxy) || (isPlainObject(proxy) && isNonEmptyString(proxy.host) && isNumber(proxy.port)),
   assets: isArrayOf(
-    asset => isStringOrStringArray(asset) || (isPlainObject(asset) && isStringOrStringArray(asset.path))
+    (asset) => isStringOrStringArray(asset) || (isPlainObject(asset) && isStringOrStringArray(asset.path))
   ),
   successComment: canBeDisabled(isNonEmptyString),
   failTitle: canBeDisabled(isNonEmptyString),
@@ -23,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) => {
@@ -68,6 +71,14 @@ module.exports = async (pluginConfig, context) => {
         },
       } = await github.repos.get({repo, owner});
       if (!push) {
+        // If authenticated as GitHub App installation, `push` will always be false.
+        // We send another request to check if current authentication is an installation.
+        // Note: we cannot check if the installation has all required permissions, it's
+        // up to the user to make sure it has
+        if (await github.request('HEAD /installation/repositories', {per_page: 1}).catch(() => false)) {
+          return;
+        }
+
         errors.push(getError('EGHNOPERMISSION', {owner, repo}));
       }
     } catch (error) {

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.5",
+  "version": "7.1.1",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "ava": {
     "files": [
@@ -45,7 +45,7 @@
     "server-destroy": "^1.0.1",
     "sinon": "^9.0.0",
     "tempy": "^0.5.0",
-    "xo": "^0.28.0"
+    "xo": "^0.30.0"
   },
   "engines": {
     "node": ">=10.18"
@@ -110,7 +110,8 @@
         {
           "properties": "never"
         }
-      ]
+      ],
+      "unicorn/string-content": "off"
     }
   }
 }