feat: allow conditional skip on success and fail comments

lib/fail.js

@@ -23,14 +23,19 @@ export default async function fail(pluginConfig, context, { Octokit }) {
     githubApiPathPrefix,
     githubApiUrl,
     proxy,
-    failComment,
     failTitle,
+    failComment,
+    failCommentCondition,
     labels,
     assignees,
   } = resolveConfig(pluginConfig, context);
 
   if (failComment === false || failTitle === false) {
     logger.log("Skip issue creation.");
+    logger.error(`Failure reporting should be disabled via 'failCommentCondition'.
+      Using 'false' for 'failComment' or 'failTitle' is deprecated and will be removed in a future major version.`);
+  } else if (failCommentCondition === false) {
+    logger.log("Skip issue creation.");
   } else {
     const octokit = new Octokit(
       toOctokitOptions({
@@ -52,31 +57,45 @@ export default async function fail(pluginConfig, context, { Octokit }) {
       : 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);
-      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);
+    const canCommentOnOrCreateIssue = failCommentCondition
+      ? template(failCommentCondition)({ ...context, issue: srIssue })
+      : true;
+
+    if (canCommentOnOrCreateIssue) {
+      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);
+        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);
+      } else {
+        const newIssue = {
+          owner,
+          repo,
+          title: failTitle,
+          body: `${body}\n\n${ISSUE_ID}`,
+          labels: labels || [],
+          assignees,
+        };
+        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);
+      }
     } else {
-      const newIssue = {
-        owner,
-        repo,
-        title: failTitle,
-        body: `${body}\n\n${ISSUE_ID}`,
-        labels: labels || [],
-        assignees,
-      };
-      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);
+      logger.log("Skip commenting on or creating an issue.");
     }
   }
 }

lib/resolve-config.js

@@ -8,8 +8,10 @@ export default function resolveConfig(
     proxy,
     assets,
     successComment,
+    successCommentCondition,
     failTitle,
     failComment,
+    failCommentCondition,
     labels,
     assignees,
     releasedLabels,
@@ -30,10 +32,12 @@ export default function resolveConfig(
     proxy: isNil(proxy) ? env.http_proxy || env.HTTP_PROXY || false : proxy,
     assets: assets ? castArray(assets) : assets,
     successComment,
+    successCommentCondition,
     failTitle: isNil(failTitle)
       ? "The automated release is failing 🚨"
       : failTitle,
     failComment,
+    failCommentCondition,
     labels: isNil(labels)
       ? ["semantic-release"]
       : labels === false

lib/success.js

@@ -29,8 +29,10 @@ export default async function success(pluginConfig, context, { Octokit }) {
     githubApiUrl,
     proxy,
     successComment,
-    failComment,
+    successCommentCondition,
     failTitle,
+    failComment,
+    failCommentCondition,
     releasedLabels,
     addReleases,
   } = resolveConfig(pluginConfig, context);
@@ -56,6 +58,10 @@ export default async function success(pluginConfig, context, { Octokit }) {
 
   if (successComment === false) {
     logger.log("Skip commenting on issues and pull requests.");
+    logger.error(`Issue and pull request comments should be disabled via 'successCommentCondition'.
+      Using 'false' for 'successComment' is deprecated and will be removed in a future major version.`);
+  } else if (successCommentCondition === false) {
+    logger.log("Skip commenting on issues and pull requests.");
   } else {
     const parser = issueParser(
       "github",
@@ -127,54 +133,62 @@ export default async function success(pluginConfig, context, { Octokit }) {
 
     await Promise.all(
       uniqBy([...prs, ...issues], "number").map(async (issue) => {
-        const body = successComment
-          ? template(successComment)({ ...context, issue })
-          : getSuccessComment(issue, releaseInfos, nextRelease);
-        try {
-          const comment = { owner, repo, issue_number: issue.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", issue.number, url);
+        const canCommentOnIssuesAndPRs = successCommentCondition
+          ? template(successCommentCondition)({ ...context, issue })
+          : true;
 
-          if (releasedLabels) {
-            const labels = releasedLabels.map((label) =>
-              template(label)(context),
-            );
-            await octokit.request(
-              "POST /repos/{owner}/{repo}/issues/{issue_number}/labels",
-              {
-                owner,
-                repo,
-                issue_number: issue.number,
-                data: labels,
-              },
+        if (canCommentOnIssuesAndPRs) {
+          const body = successComment
+            ? template(successComment)({ ...context, issue })
+            : getSuccessComment(issue, releaseInfos, nextRelease);
+          try {
+            const comment = { owner, repo, issue_number: issue.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 labels %O to issue #%d", labels, issue.number);
-          }
-        } catch (error) {
-          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,
-            );
-          } else {
-            errors.push(error);
-            logger.error(
-              "Failed to add a comment to the issue #%d.",
-              issue.number,
-            );
-            // Don't throw right away and continue to update other issues
+            logger.log("Added comment to issue #%d: %s", issue.number, url);
+
+            if (releasedLabels) {
+              const labels = releasedLabels.map((label) =>
+                template(label)(context),
+              );
+              await octokit.request(
+                "POST /repos/{owner}/{repo}/issues/{issue_number}/labels",
+                {
+                  owner,
+                  repo,
+                  issue_number: issue.number,
+                  data: labels,
+                },
+              );
+              logger.log("Added labels %O to issue #%d", labels, issue.number);
+            }
+          } catch (error) {
+            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,
+              );
+            } else {
+              errors.push(error);
+              logger.error(
+                "Failed to add a comment to the issue #%d.",
+                issue.number,
+              );
+              // Don't throw right away and continue to update other issues
+            }
           }
+        } else {
+          logger.log("Skip commenting on issue #%d.", issue.id);
         }
       }),
     );

test/fail.test.js

@@ -447,3 +447,149 @@ test('Skip if "failTitle" is "false"', async (t) => {
 
   t.true(t.context.log.calledWith("Skip issue creation."));
 });
+
+test('Does not post comments if "failCommentCondition" is "false"', async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const pluginConfig = { failCommentCondition: false };
+  const options = { repositoryUrl: `https://github.com/${owner}/${repo}.git` };
+
+  await fail(
+    pluginConfig,
+    {
+      env,
+      options,
+      branch: { name: "master" },
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.true(t.context.log.calledWith("Skip issue creation."));
+});
+
+test('Does not post comments on existing issues when "failCommentCondition" is "false"', async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const failTitle = "The automated release is failing 🚨";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const pluginConfig = { failCommentCondition: "<% return false; %>" };
+  const options = { repositoryUrl: `https://github.com/${owner}/${repo}.git` };
+  const errors = [
+    new SemanticReleaseError("Error message 1", "ERR1", "Error 1 details"),
+    new SemanticReleaseError("Error message 2", "ERR2", "Error 2 details"),
+    new SemanticReleaseError("Error message 3", "ERR3", "Error 3 details"),
+  ];
+  const issues = [
+    { number: 1, body: "Issue 1 body", title: failTitle },
+    { number: 2, body: `Issue 2 body\n\n${ISSUE_ID}`, title: failTitle },
+    { number: 3, body: `Issue 3 body\n\n${ISSUE_ID}`, title: failTitle },
+  ];
+
+  const fetch = fetchMock
+    .sandbox()
+    .getOnce(`https://api.github.local/repos/${owner}/${repo}`, {
+      full_name: `${owner}/${repo}`,
+    })
+    .getOnce(
+      `https://api.github.local/search/issues?q=${encodeURIComponent(
+        "in:title",
+      )}+${encodeURIComponent(`repo:${owner}/${repo}`)}+${encodeURIComponent(
+        "type:issue",
+      )}+${encodeURIComponent("state:open")}+${encodeURIComponent(failTitle)}`,
+      { items: issues },
+    );
+
+  await fail(
+    pluginConfig,
+    {
+      env,
+      options,
+      branch: { name: "master" },
+      errors,
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.true(fetch.done());
+  t.true(t.context.log.calledWith("Skip commenting on or creating an issue."));
+});
+
+test(`Post new issue if none exists yet, but don't comment on existing issues when "failCommentCondition" is disallows it`, async (t) => {
+  const owner = "test_user";
+  const repo = "test_repo";
+  const env = { GITHUB_TOKEN: "github_token" };
+  const errors = [{ message: "An error occured" }];
+  const failTitle = "The automated release is failing 🚨";
+  const pluginConfig = {
+    failTitle,
+    failComment: `Error: Release for branch \${branch.name} failed with error: \${errors.map(error => error.message).join(';')}`,
+    failCommentCondition: "<% return !issue; %>",
+  };
+  const options = {
+    repositoryUrl: `https://github.com/${owner}/${repo}.git`,
+  };
+
+  const fetch = fetchMock
+    .sandbox()
+    .getOnce(`https://api.github.local/repos/${owner}/${repo}`, {
+      full_name: `${owner}/${repo}`,
+    })
+    .getOnce(
+      `https://api.github.local/search/issues?q=${encodeURIComponent(
+        "in:title",
+      )}+${encodeURIComponent(`repo:${owner}/${repo}`)}+${encodeURIComponent(
+        "type:issue",
+      )}+${encodeURIComponent("state:open")}+${encodeURIComponent(failTitle)}`,
+      { items: [] },
+    )
+    .postOnce(
+      (url, { body }) => {
+        t.is(url, `https://api.github.local/repos/${owner}/${repo}/issues`);
+        t.regex(
+          JSON.parse(body).body,
+          /Error: Release for branch master failed with error: An error occured\n\n<!-- semantic-release:github -->/,
+        );
+        return true;
+      },
+      { html_url: "https://github.com/issues/2", number: 2 },
+    );
+
+  await fail(
+    pluginConfig,
+    {
+      env,
+      options,
+      branch: { name: "master" },
+      errors,
+      logger: t.context.logger,
+    },
+    {
+      Octokit: TestOctokit.defaults((options) => ({
+        ...options,
+        request: { ...options.request, fetch },
+      })),
+    },
+  );
+
+  t.true(fetch.done());
+  t.true(
+    t.context.log.calledWith(
+      "Created issue #%d: %s.",
+      2,
+      "https://github.com/issues/2",
+    ),
+  );
+});