From 3b947034c316817ef131c8fefe3151a1ae47556f Mon Sep 17 00:00:00 2001
From: Charles Treatman <ctreatman@equinix.com>
Date: Mon, 21 Oct 2024 10:03:26 -0500
Subject: [PATCH] chore(ci): disable release comments to avoid secondary rate
 limit (#246)

The release workflow occasionally fails due to GitHub API rate limiting
on the success comments that are posted to every issue and PR that is
included in the release. While it's possible this problem has been
addressed in the latest version of `semantic-release/github`, I still
think it's better to disable those comments and avoid the problem
entirely.
---
 .releaserc.json | 79 +++++++++++++++++++++++++------------------------
 1 file changed, 40 insertions(+), 39 deletions(-)

diff --git a/.releaserc.json b/.releaserc.json
index 47e7f13..5b6ca5a 100644
--- a/.releaserc.json
+++ b/.releaserc.json
@@ -1,42 +1,43 @@
 {
-    "branches": [
-      "main"
+  "branches": [
+    "main"
+  ],
+  "ci": false,
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
     ],
-    "ci": false,
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "conventionalcommits"
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "conventionalcommits"
-        }
-      ],
-      [
-        "@semantic-release/github",
-        {
-          "successComment": "This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${nextRelease.version} :tada:",
-          "labels": false,
-          "releasedLabels": false
-        }
-      ],
-      [
-        "@semantic-release/exec",
-        {
-          "prepareCmd": "echo -n '${nextRelease.version}' > version && make docs"
-        }
-      ],
-      [
-        "@semantic-release/git",
-        {
-          "message": "ci: regenerate code for version ${nextRelease.version} triggered by ${process.env.RELEASE_REQUESTER}",
-          "assets": ["."]
-        }
-      ]
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "successComment": false,
+        "labels": false,
+        "releasedLabels": false
+      }
+    ],
+    [
+      "@semantic-release/exec",
+      {
+        "prepareCmd": "echo -n '${nextRelease.version}' > version && make docs"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "message": "ci: regenerate code for version ${nextRelease.version} triggered by ${process.env.RELEASE_REQUESTER}",
+        "assets": [
+          "."
+        ]
+      }
     ]
-  }
-
+  ]
+}