feat: allow conditional skip on success and fail comments

lib/fail.js

@@ -23,14 +23,21 @@ 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.");
+    // TODO: use logger.warn() instead of logger.log()
+    logger.log(
+      `DEPRECATION: 'false' for 'failComment' or 'failTitle' is deprecated and will be removed in a future major version. Use 'failCommentCondition' instead.`,
+    );
+  } else if (failCommentCondition === false) {
+    logger.log("Skip issue creation.");
   } else {
     const octokit = new Octokit(
       toOctokitOptions({
@@ -52,6 +59,15 @@ export default async function fail(pluginConfig, context, { Octokit }) {
       : getFailComment(branch, errors);
     const [srIssue] = await findSRIssues(octokit, failTitle, owner, repo);
 
+    const canCommentOnOrCreateIssue = failCommentCondition
+      ? template(failCommentCondition)({ ...context, issue: srIssue })
+      : true;
+
+    if (!canCommentOnOrCreateIssue) {
+      logger.log("Skip commenting on or creating an issue.");
+      return;
+    }
+
     if (srIssue) {
       logger.log("Found existing semantic-release issue #%d.", srIssue.number);
       const comment = { owner, repo, issue_number: srIssue.number, body };

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);
@@ -59,6 +61,12 @@ export default async function success(pluginConfig, context, { Octokit }) {
       logger.log("No commits found in release");
     }
     logger.log("Skip commenting on issues and pull requests.");
+    // TODO: use logger.warn() instead of logger.log()
+    logger.log(
+      `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 {
     const parser = issueParser(
       "github",
@@ -71,9 +79,7 @@ export default async function success(pluginConfig, context, { Octokit }) {
       buildAssociatedPRsQuery(shas),
       { owner, repo },
     );
-    const associatedPRs = Object.values(repository).map(
-      (item) => item.associatedPullRequests.nodes,
-    );
+    const associatedPRs = buildAssociatedPRs(repository);
 
     const uniqueAssociatedPRs = uniqBy(flatten(associatedPRs), "number");
 
@@ -130,6 +136,15 @@ export default async function success(pluginConfig, context, { Octokit }) {
 
     await Promise.all(
       uniqBy([...prs, ...issues], "number").map(async (issue) => {
+        const canCommentOnIssue = successCommentCondition
+          ? template(successCommentCondition)({ ...context, issue })
+          : true;
+
+        if (!canCommentOnIssue) {
+          logger.log("Skip commenting on issue #%d.", issue.id);
+          return;
+        }
+
         const body = successComment
           ? template(successComment)({ ...context, issue })
           : getSuccessComment(issue, releaseInfos, nextRelease);
@@ -262,9 +277,62 @@ export function buildAssociatedPRsQuery(shas) {
             ...on Commit {
               associatedPullRequests(first: 100) {
                 nodes {
+                  id
+                  title
+                  body
                   url
                   number
-                  body
+                  createdAt
+                  updatedAt
+                  closedAt
+                  mergedAt
+                  isDraft
+                  mergedBy {
+                    login
+                    avatarUrl
+                    url
+                  }
+                  commits {
+                    totalCount
+                  }
+                  comments {
+                    totalCount
+                  }
+                  state
+                  author {
+                    login
+                    url
+                    avatarUrl
+                  }
+                  labels(first: 100) {
+                    nodes {
+                      id
+                      url
+                      name
+                      color
+                    }
+                  }
+                  milestone {
+                    url
+                    id
+                    number
+                    state
+                    title
+                    description
+                    creator {
+                      login
+                      url
+                      avatarUrl
+                    }
+                    createdAt
+                    closedAt
+                    updatedAt
+                  }
+                  locked
+                  activeLockReason
+                  mergeable
+                  canBeRebased
+                  changedFiles
                 }
               }
             }
@@ -275,3 +343,67 @@ export function buildAssociatedPRsQuery(shas) {
     }
   `;
 }
+
+/**
+ * Build associatedPRs (into issue-like object with `pull_request` property) from the GraphQL repository response
+ * @param {object} repository
+ * @returns {object[]}
+ */
+function buildAssociatedPRs(repository) {
+  const associatedPRs = [];
+  for (const commit in repository) {
+    for (const node of repository[commit].associatedPullRequests.nodes) {
+      const pr = {
+        pull_request: true,
+        number: node.number,
+        title: node.title,
+        body: node.body,
+        labels: node.labels?.nodes.map((label) => label.name),
+        html_url: node.url,
+        created_at: node.createdAt,
+        updated_at: node.updatedAt,
+        closed_at: node.closedAt,
+        merged_at: node.mergedAt,
+        draft: node.isDraft,
+        user: {
+          login: node.author?.login,
+          html_url: node.author?.url,
+          avatar_url: node.author?.avatarUrl,
+        },
+        commits: node.commits?.totalCount,
+        comments: node.comments?.totalCount,
+        state: node.state,
+        merged_by: {
+          login: node.mergedBy?.login,
+          avatar_url: node.mergedBy?.avatarUrl,
+          html_url: node.mergedBy?.url,
+        },
+        milestone: node.milestone
+          ? {
+              url: node.milestone.url,
+              id: node.milestone.id,
+              number: node.milestone.number,
+              state: node.milestone.state,
+              title: node.milestone.title,
+              description: node.milestone.description,
+              creator: {
+                login: node.milestone.creator.login,
+                html_url: node.milestone.creator.url,
+                avatar_url: node.milestone.creator.avatarUrl,
+              },
+              created_at: node.milestone.createdAt,
+              closed_at: node.milestone.closedAt,
+              updated_at: node.milestone.updatedAt,
+            }
+          : null,
+        locked: node.locked,
+        active_lock_reason: node.activeLockReason,
+        mergeable: node.mergeable,
+        rebaseable: node.canBeRebased,
+        changed_files: node.changedFiles,
+      };
+      associatedPRs.push(pr);
+    }
+  }
+  return associatedPRs;
+}

lib/verify.js

@@ -38,8 +38,10 @@ const VALIDATORS = {
       (isPlainObject(asset) && isStringOrStringArray(asset.path)),
   ),
   successComment: canBeDisabled(isNonEmptyString),
+  successCommentCondition: canBeDisabled(isNonEmptyString),
   failTitle: canBeDisabled(isNonEmptyString),
   failComment: canBeDisabled(isNonEmptyString),
+  failCommentCondition: canBeDisabled(isNonEmptyString),
   labels: canBeDisabled(isArrayOf(isNonEmptyString)),
   assignees: isArrayOf(isNonEmptyString),
   releasedLabels: canBeDisabled(isArrayOf(isNonEmptyString)),