@semantic-release/github 8.1.0 → 9.0.0-beta.1

package/lib/definitions/errors.js

@@ -1,121 +1,197 @@
-const {inspect} = require('util');
-const {isString} = require('lodash');
-const pkg = require('../../package.json');
+import { inspect } from "node:util";
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
 
-const [homepage] = pkg.homepage.split('#');
-const stringify = (object) =>
-  isString(object) ? object : inspect(object, {breakLength: Infinity, depth: 2, maxArrayLength: 5});
-const linkify = (file) => `${homepage}/blob/master/${file}`;
+import { isString } from "lodash-es";
+
+const pkg = require("../../package.json");
+const HOMEPAGE = pkg.homepage;
 
-module.exports = {
-  EINVALIDASSETS: ({assets}) => ({
-    message: 'Invalid `assets` option.',
+const stringify = (object) =>
+  isString(object)
+    ? object
+    : inspect(object, {
+        breakLength: Number.POSITIVE_INFINITY,
+        depth: 2,
+        maxArrayLength: 5,
+      });
+const linkify = (file) => `${HOMEPAGE}/blob/master/${file}`;
+
+export function EINVALIDASSETS({ assets }) {
+  return {
+    message: "Invalid `assets` option.",
     details: `The [assets option](${linkify(
-      'README.md#assets'
+      "README.md#assets"
     )}) must be an \`Array\` of \`Strings\` or \`Objects\` with a \`path\` property.
 
 Your configuration for the \`assets\` option is \`${stringify(assets)}\`.`,
-  }),
-  EINVALIDSUCCESSCOMMENT: ({successComment}) => ({
-    message: 'Invalid `successComment` option.',
+  };
+}
+
+export function EINVALIDSUCCESSCOMMENT({ successComment }) {
+  return {
+    message: "Invalid `successComment` option.",
     details: `The [successComment option](${linkify(
-      'README.md#successcomment'
+      "README.md#successcomment"
+    )}) if defined, must be a non empty \`String\`.
+
+Your configuration for the \`successComment\` option is \`${stringify(
+      successComment
+    )}\`.`,
+  };
+}
+
+export function EINVALIDFAILTITLE({ failTitle }) {
+  return {
+    message: "Invalid `failTitle` option.",
+    details: `The [failTitle option](${linkify(
+      "README.md#failtitle"
+    )}) if defined, must be a non empty \`String\`.
+
+Your configuration for the \`failTitle\` option is \`${stringify(
+      failTitle
+    )}\`.`,
+  };
+}
+
+export function EINVALIDFAILCOMMENT({ failComment }) {
+  return {
+    message: "Invalid `failComment` option.",
+    details: `The [failComment option](${linkify(
+      "README.md#failcomment"
     )}) if defined, must be a non empty \`String\`.
 
-Your configuration for the \`successComment\` option is \`${stringify(successComment)}\`.`,
-  }),
-  EINVALIDFAILTITLE: ({failTitle}) => ({
-    message: 'Invalid `failTitle` option.',
-    details: `The [failTitle option](${linkify('README.md#failtitle')}) if defined, must be a non empty \`String\`.
-
-Your configuration for the \`failTitle\` option is \`${stringify(failTitle)}\`.`,
-  }),
-  EINVALIDFAILCOMMENT: ({failComment}) => ({
-    message: 'Invalid `failComment` option.',
-    details: `The [failComment option](${linkify('README.md#failcomment')}) if defined, must be a non empty \`String\`.
-
-Your configuration for the \`failComment\` option is \`${stringify(failComment)}\`.`,
-  }),
-  EINVALIDLABELS: ({labels}) => ({
-    message: 'Invalid `labels` option.',
+Your configuration for the \`failComment\` option is \`${stringify(
+      failComment
+    )}\`.`,
+  };
+}
+
+export function EINVALIDLABELS({ labels }) {
+  return {
+    message: "Invalid `labels` option.",
     details: `The [labels option](${linkify(
-      'README.md#options'
+      "README.md#options"
     )}) if defined, must be an \`Array\` of non empty \`String\`.
 
 Your configuration for the \`labels\` option is \`${stringify(labels)}\`.`,
-  }),
-  EINVALIDASSIGNEES: ({assignees}) => ({
-    message: 'Invalid `assignees` option.',
-    details: `The [assignees option](${linkify('README.md#options')}) must be an \`Array\` of non empty \`Strings\`.
-
-Your configuration for the \`assignees\` option is \`${stringify(assignees)}\`.`,
-  }),
-  EINVALIDRELEASEDLABELS: ({releasedLabels}) => ({
-    message: 'Invalid `releasedLabels` option.',
+  };
+}
+
+export function EINVALIDASSIGNEES({ assignees }) {
+  return {
+    message: "Invalid `assignees` option.",
+    details: `The [assignees option](${linkify(
+      "README.md#options"
+    )}) must be an \`Array\` of non empty \`Strings\`.
+
+Your configuration for the \`assignees\` option is \`${stringify(
+      assignees
+    )}\`.`,
+  };
+}
+
+export function EINVALIDRELEASEDLABELS({ releasedLabels }) {
+  return {
+    message: "Invalid `releasedLabels` option.",
     details: `The [releasedLabels option](${linkify(
-      'README.md#options'
+      "README.md#options"
     )}) 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)}\`.`,
-  }),
-  EINVALIDDRAFTRELEASE: ({draftRelease}) => ({
-    message: 'Invalid `draftRelease` option.',
-    details: `The [draftRelease option](${linkify('README.md#options')}) if defined, must be a \`Boolean\`.
-
-Your configuration for the \`draftRelease\` option is \`${stringify(draftRelease)}\`.`,
-  }),
-  EINVALIDGITHUBURL: () => ({
-    message: 'The git repository URL is not a valid GitHub URL.',
+Your configuration for the \`releasedLabels\` option is \`${stringify(
+      releasedLabels
+    )}\`.`,
+  };
+}
+
+export function EINVALIDADDRELEASES({ addReleases }) {
+  return {
+    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
+    )}\`.`,
+  };
+}
+
+export function EINVALIDDRAFTRELEASE({ draftRelease }) {
+  return {
+    message: "Invalid `draftRelease` option.",
+    details: `The [draftRelease option](${linkify(
+      "README.md#options"
+    )}) if defined, must be a \`Boolean\`.
+
+Your configuration for the \`draftRelease\` option is \`${stringify(
+      draftRelease
+    )}\`.`,
+  };
+}
+
+export function EINVALIDGITHUBURL() {
+  return {
+    message: "The git repository URL is not a valid GitHub URL.",
     details: `The **semantic-release** \`repositoryUrl\` option must a valid GitHub URL with the format \`<GitHub_or_GHE_URL>/<owner>/<repo>.git\`.
 
 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.`,
-  }),
-  EINVALIDPROXY: ({proxy}) => ({
-    message: 'Invalid `proxy` option.',
+  };
+}
+
+export function EINVALIDPROXY({ proxy }) {
+  return {
+    message: "Invalid `proxy` option.",
     details: `The [proxy option](${linkify(
-      'README.md#proxy'
+      "README.md#proxy"
     )}) must be a \`String\`  or an \`Objects\` with a \`host\` and a \`port\` property.
 
 Your configuration for the \`proxy\` option is \`${stringify(proxy)}\`.`,
-  }),
-  EMISSINGREPO: ({owner, repo}) => ({
+  };
+}
+
+export function EMISSINGREPO({ owner, repo }) {
+  return {
     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.
 
 If you are using [GitHub Enterprise](https://enterprise.github.com) please make sure to configure the \`githubUrl\` and \`githubApiPathPrefix\` [options](${linkify(
-      'README.md#options'
+      "README.md#options"
     )}).`,
-  }),
-  EGHNOPERMISSION: ({owner, repo}) => ({
+  };
+}
+
+export function EGHNOPERMISSION({ owner, repo }) {
+  return {
     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'
+      "README.md#github-authentication"
     )}) configured in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable must allows to push to the repository ${owner}/${repo}.
 
 Please make sure the GitHub user associated with the token is an [owner](https://help.github.com/articles/permission-levels-for-a-user-account-repository/#owner-access-on-a-repository-owned-by-a-user-account) or a [collaborator](https://help.github.com/articles/permission-levels-for-a-user-account-repository/#collaborator-access-on-a-repository-owned-by-a-user-account) if the reposotory belong to a user account or has [write permissions](https://help.github.com/articles/managing-team-access-to-an-organization-repository) if the repository [belongs to an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization).`,
-  }),
-  EINVALIDGHTOKEN: ({owner, repo}) => ({
-    message: 'Invalid GitHub token.',
+  };
+}
+
+export function EINVALIDGHTOKEN({ owner, repo }) {
+  return {
+    message: "Invalid GitHub token.",
     details: `The [GitHub token](${linkify(
-      'README.md#github-authentication'
+      "README.md#github-authentication"
     )}) configured in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable must be a valid [personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) allowing to push to the repository ${owner}/${repo}.
 
 Please make sure to set the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable in your CI with the exact value of the GitHub personal token.`,
-  }),
-  ENOGHTOKEN: ({owner, repo}) => ({
-    message: 'No GitHub token specified.',
+  };
+}
+
+export function ENOGHTOKEN({ owner, repo }) {
+  return {
+    message: "No GitHub token specified.",
     details: `A [GitHub personal token](${linkify(
-      'README.md#github-authentication'
+      "README.md#github-authentication"
     )}) must be created and set in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable on your CI environment.
 
 Please make sure to create a [GitHub personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) and to set it in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${owner}/${repo}.`,
-  }),
-};
+  };
+}

package/lib/definitions/retry.js

@@ -1,10 +1,8 @@
 /**
  * Default exponential backoff configuration for retries.
  */
-const RETRY_CONF = {
+export const RETRY_CONF = {
   // By default, Octokit does not retry on 404s.
   // But we want to retry on 404s to account for replication lag.
   doNotRetry: [400, 401, 403, 422],
 };
-
-module.exports = {RETRY_CONF};

package/lib/definitions/throttle.js

@@ -2,6 +2,4 @@
  * Default configuration for throttle.
  * @see https://github.com/octokit/plugin-throttling.js#options
  */
-const THROTTLE_CONF = {};
-
-module.exports = {THROTTLE_CONF};
+export const THROTTLE_CONF = {};

package/lib/fail.js

@@ -1,42 +1,61 @@
-const {template} = require('lodash');
-const debug = require('debug')('semantic-release:github');
-const parseGithubUrl = require('./parse-github-url');
-const {ISSUE_ID} = require('./definitions/constants');
-const resolveConfig = require('./resolve-config');
-const getClient = require('./get-client');
-const findSRIssues = require('./find-sr-issues');
-const getFailComment = require('./get-fail-comment');
+import { template } from "lodash-es";
+import debugFactory from "debug";
 
-module.exports = async (pluginConfig, context) => {
+import parseGithubUrl from "./parse-github-url.js";
+import { ISSUE_ID } from "./definitions/constants.js";
+import resolveConfig from "./resolve-config.js";
+import { toOctokitOptions, SemanticReleaseOctokit } from "./octokit.js";
+import findSRIssues from "./find-sr-issues.js";
+import getFailComment from "./get-fail-comment.js";
+
+const debug = debugFactory("semantic-release:github");
+
+export default async function fail(pluginConfig, context, { Octokit }) {
   const {
-    options: {repositoryUrl},
+    options: { repositoryUrl },
     branch,
     errors,
     logger,
   } = context;
-  const {githubToken, githubUrl, githubApiPathPrefix, proxy, failComment, failTitle, labels, assignees} = resolveConfig(
-    pluginConfig,
-    context
-  );
+  const {
+    githubToken,
+    githubUrl,
+    githubApiPathPrefix,
+    proxy,
+    failComment,
+    failTitle,
+    labels,
+    assignees,
+  } = resolveConfig(pluginConfig, context);
 
   if (failComment === false || failTitle === false) {
-    logger.log('Skip issue creation.');
+    logger.log("Skip issue creation.");
   } else {
-    const octokit = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
+    const octokit = new Octokit(
+      toOctokitOptions({ githubToken, githubUrl, githubApiPathPrefix, proxy })
+    );
     // In case the repo changed name, get the new `repo`/`owner` as the search API will not follow redirects
-    const {data: repoData} = await octokit.request('GET /repos/{owner}/{repo}', parseGithubUrl(repositoryUrl));
-    const [owner, repo] = repoData.full_name.split('/');
-    const body = failComment ? template(failComment)({branch, errors}) : getFailComment(branch, errors);
+    const { data: repoData } = await octokit.request(
+      "GET /repos/{owner}/{repo}",
+      parseGithubUrl(repositoryUrl)
+    );
+    const [owner, repo] = repoData.full_name.split("/");
+    const body = failComment
+      ? template(failComment)({ branch, errors })
+      : getFailComment(branch, errors);
     const [srIssue] = await findSRIssues(octokit, failTitle, owner, repo);
 
     if (srIssue) {
-      logger.log('Found existing semantic-release issue #%d.', srIssue.number);
-      const comment = {owner, repo, issue_number: srIssue.number, body};
-      debug('create comment: %O', comment);
+      logger.log("Found existing semantic-release issue #%d.", srIssue.number);
+      const comment = { owner, repo, issue_number: srIssue.number, body };
+      debug("create comment: %O", comment);
       const {
-        data: {html_url: url},
-      } = await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', comment);
-      logger.log('Added comment to issue #%d: %s.', srIssue.number, url);
+        data: { html_url: url },
+      } = await octokit.request(
+        "POST /repos/{owner}/{repo}/issues/{issue_number}/comments",
+        comment
+      );
+      logger.log("Added comment to issue #%d: %s.", srIssue.number, url);
     } else {
       const newIssue = {
         owner,
@@ -46,11 +65,11 @@ module.exports = async (pluginConfig, context) => {
         labels: labels || [],
         assignees,
       };
-      debug('create issue: %O', newIssue);
+      debug("create issue: %O", newIssue);
       const {
-        data: {html_url: url, number},
-      } = await octokit.request('POST /repos/{owner}/{repo}/issues', newIssue);
-      logger.log('Created issue #%d: %s.', number, url);
+        data: { html_url: url, number },
+      } = await octokit.request("POST /repos/{owner}/{repo}/issues", newIssue);
+      logger.log("Created issue #%d: %s.", number, url);
     }
   }
-};
+}

package/lib/find-sr-issues.js

@@ -1,9 +1,9 @@
-const {ISSUE_ID} = require('./definitions/constants');
+import { ISSUE_ID } from "./definitions/constants.js";
 
-module.exports = async (octokit, title, owner, repo) => {
+export default async (octokit, title, owner, repo) => {
   const {
-    data: {items: issues},
-  } = await octokit.request('GET /search/issues', {
+    data: { items: issues },
+  } = await octokit.request("GET /search/issues", {
     q: `in:title+repo:${owner}/${repo}+type:issue+state:open+${title}`,
   });
 

package/lib/get-error.js

@@ -1,7 +1,8 @@
-const SemanticReleaseError = require('@semantic-release/error');
-const ERROR_DEFINITIONS = require('./definitions/errors');
+import SemanticReleaseError from "@semantic-release/error";
 
-module.exports = (code, ctx = {}) => {
-  const {message, details} = ERROR_DEFINITIONS[code](ctx);
+import * as ERROR_DEFINITIONS from "./definitions/errors.js";
+
+export default function getError(code, ctx = {}) {
+  const { message, details } = ERROR_DEFINITIONS[code](ctx);
   return new SemanticReleaseError(message, code, details);
-};
+}

package/lib/get-fail-comment.js

@@ -1,4 +1,4 @@
-const HOME_URL = 'https://github.com/semantic-release/semantic-release';
+const HOME_URL = "https://github.com/semantic-release/semantic-release";
 const FAQ_URL = `${HOME_URL}/blob/caribou/docs/support/FAQ.md`;
 const GET_HELP_URL = `${HOME_URL}#get-help`;
 const USAGE_DOC_URL = `${HOME_URL}/blob/caribou/docs/usage/README.md`;
@@ -11,13 +11,14 @@ ${
   `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
-}\` branch failed. :rotating_light:
+export default function getFailComment(branch, errors) {
+  return `## :rotating_light: The automated release from the \`${
+    branch.name
+  }\` branch failed. :rotating_light:
 
 I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.
 
@@ -26,8 +27,8 @@ You can find below the list of errors reported by **semantic-release**. Each one
 Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.
 
 Once all the errors are resolved, **semantic-release** will release your package the next time you push a commit to the \`${
-  branch.name
-}\` branch. You can also manually restart the failed CI job that runs **semantic-release**.
+    branch.name
+  }\` branch. You can also manually restart the failed CI job that runs **semantic-release**.
 
 If you are not sure how to resolve this, here are some links that can help you:
 - [Usage documentation](${USAGE_DOC_URL})
@@ -38,10 +39,11 @@ If those don’t help, or if this issue is reporting something you think isn’t
 
 ---
 
-${errors.map((error) => formatError(error)).join('\n\n---\n\n')}
+${errors.map((error) => formatError(error)).join("\n\n---\n\n")}
 
 ---
 
 Good luck with your project ✨
 
 Your **[semantic-release](${HOME_URL})** bot :package::rocket:`;
+}

package/lib/get-release-links.js

@@ -1,22 +1,25 @@
-const {RELEASE_NAME} = require('./definitions/constants');
+import { RELEASE_NAME } from "./definitions/constants.js";
 
 const linkify = (releaseInfo) =>
   `${
     releaseInfo.url
-      ? releaseInfo.url.startsWith('http')
+      ? 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);
+  releaseInfos.filter(
+    (releaseInfo) => releaseInfo.name && releaseInfo.name !== RELEASE_NAME
+  );
 
-module.exports = (releaseInfos) =>
-  `${
+export default function getReleaseLinks(releaseInfos) {
+  return `${
     filterReleases(releaseInfos).length > 0
       ? `This release is also available on:\n${filterReleases(releaseInfos)
           .map((releaseInfo) => `- ${linkify(releaseInfo)}`)
-          .join('\n')}`
-      : ''
+          .join("\n")}`
+      : ""
   }`;
+}

package/lib/get-search-queries.js

@@ -1,8 +1,11 @@
-module.exports = (base, commits, separator = '+') => {
+export default function getSearchQueries(base, commits, separator = "+") {
   return commits.reduce((searches, commit) => {
     const lastSearch = searches[searches.length - 1];
 
-    if (lastSearch && lastSearch.length + commit.length <= 256 - separator.length) {
+    if (
+      lastSearch &&
+      lastSearch.length + commit.length <= 256 - separator.length
+    ) {
       searches[searches.length - 1] = `${lastSearch}${separator}${commit}`;
     } else {
       searches.push(`${base}${separator}${commit}`);
@@ -10,4 +13,4 @@ module.exports = (base, commits, separator = '+') => {
 
     return searches;
   }, []);
-};
+}

package/lib/get-success-comment.js

@@ -1,18 +1,25 @@
-const HOME_URL = 'https://github.com/semantic-release/semantic-release';
+const HOME_URL = "https://github.com/semantic-release/semantic-release";
 const linkify = (releaseInfo) =>
-  `${releaseInfo.url ? `[${releaseInfo.name}](${releaseInfo.url})` : `\`${releaseInfo.name}\``}`;
+  `${
+    releaseInfo.url
+      ? `[${releaseInfo.name}](${releaseInfo.url})`
+      : `\`${releaseInfo.name}\``
+  }`;
 
-module.exports = (issue, releaseInfos, nextRelease) =>
-  `:tada: This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${
-    nextRelease.version
-  } :tada:${
+export default function getSuccessComment(issue, releaseInfos, nextRelease) {
+  return `:tada: This ${
+    issue.pull_request ? "PR is included" : "issue has been resolved"
+  } in version ${nextRelease.version} :tada:${
     releaseInfos.length > 0
       ? `\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")}`
         }`
-      : ''
+      : ""
   }
 
 Your **[semantic-release](${HOME_URL})** bot :package::rocket:`;
+}