feat: allow for releasedLabels with successComment set to false

Author: kristof-mattei

lib/success.js

@@ -55,8 +55,8 @@ export default async function success(pluginConfig, context, { Octokit }) {
 
   const errors = [];
 
-  if (successComment === false) {
-    logger.log("Skip commenting on issues and pull requests.");
+  if (successComment === false && releasedLabels === false) {
+    logger.log("Skip commenting / adding labels on issues and pull requests.");
   } else {
     const parser = issueParser(
       "github",
@@ -134,20 +134,21 @@ 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);
-
+          if (successComment !== false) {
+            const body = successComment
+              ? template(successComment)({ ...context, issue })
+              : getSuccessComment(issue, releaseInfos, nextRelease);
+            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);
+          }
           if (releasedLabels) {
             const labels = releasedLabels.map((label) =>
               template(label)(context),
@@ -166,18 +167,18 @@ export default async function success(pluginConfig, context, { Octokit }) {
         } catch (error) {
           if (error.status === 403) {
             logger.error(
-              "Not allowed to add a comment to the issue #%d.",
+              "Not allowed to add comment/label 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.",
+              "Failed to add comment/label 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.",
+              "Failed to add comment/label to the issue #%d.",
               issue.number,
             );
             // Don't throw right away and continue to update other issues

test/integration.test.js

@@ -462,7 +462,7 @@ test("Comment and add labels on PR included in the releases", async (t) => {
       `https://api.github.local/repos/${owner}/${repo}/issues/1/labels`,
       {},
       {
-        body: ["released"],
+        labels: ["released"],
       },
     )
     .getOnce(
@@ -664,7 +664,7 @@ test("Verify, release and notify success", async (t) => {
     .postOnce(
       `https://api.github.local/repos/${owner}/${repo}/issues/1/labels`,
       {},
-      { body: ["released"] },
+      { labels: ["released"] },
     )
     .getOnce(
       `https://api.github.local/search/issues?q=${encodeURIComponent(
@@ -822,7 +822,7 @@ test("Verify, update release and notify success", async (t) => {
       `https://api.github.local/repos/${owner}/${repo}/issues/1/labels`,
       {},
       {
-        body: ["released"],
+        labels: ["released"],
       },
     )
     .getOnce(