feat: allow for releasedLabels with successComment set to false

Author: kristof-mattei

lib/success.js

@@ -57,16 +57,19 @@ export default async function success(pluginConfig, context, { Octokit }) {
 
   const errors = [];
 
-  if (successComment === false || isEmpty(commits)) {
+  if (
+    (successComment === false && releasedLabels === false) ||
+    isEmpty(commits)
+  ) {
     if (isEmpty(commits)) {
       logger.log("No commits found in release");
     }
-    logger.log("Skip commenting on issues and pull requests.");
+    logger.log("Skip commenting / adding labels on issues and pull requests.");
     logger.warn(
       `DEPRECATION: 'false' for 'successComment' is deprecated and will be removed in a future major version. Use 'successCommentCondition' instead.`,
     );
-  } else if (successCommentCondition === false) {
-    logger.log("Skip commenting on issues and pull requests.");
+  } else if (successCommentCondition === false && releasedLabels === false) {
+    logger.log("Skip commenting / adding labels on issues and pull requests.");
   } else {
     const parser = issueParser(
       "github",
@@ -202,23 +205,25 @@ export default async function success(pluginConfig, context, { Octokit }) {
           return;
         }
 
-        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 ${issueOrPR} #%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 ${issueOrPR} #%d: %s`,
+              issue.number,
+              url,
+            );
+          }
 
           if (releasedLabels) {
             const labels = releasedLabels.map((label) =>
@@ -242,18 +247,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/PR #%d.`,
+              `Not allowed to add a comment/label to the issue/PR #%d.`,
               issue.number,
             );
           } else if (error.status === 404) {
             logger.error(
-              `Failed to add a comment to the issue/PR #%d as it doesn't exist.`,
+              `Failed to add a comment/label to the issue/PR #%d as it doesn't exist.`,
               issue.number,
             );
           } else {
             errors.push(error);
             logger.error(
-              `Failed to add a comment to the issue/PR #%d.`,
+              `Failed to add a comment/label to the issue/PR #%d.`,
               issue.number,
             );
             // Don't throw right away and continue to update other issues

test/integration.test.js

@@ -501,7 +501,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"],
       },
     )
     .postOnce(
@@ -749,7 +749,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(
@@ -922,7 +922,7 @@ test("Verify, update release and notify success", async (t) => {
       `https://api.github.local/repos/${owner}/${repo}/issues/1/labels`,
       {},
       {
-        body: ["released"],
+        labels: ["released"],
       },
     )
     .postOnce(