fix: prevent hitting github secondary rate limits

.changeset/rotten-carrots-pump.md

@@ -0,0 +1,21 @@
+---
+"@changesets/action": patch
+---
+
+add rate limit plugin for octokit
+
+The changesets GitHub Action triggers 403 (secondary rate limits)[1]
+against the GitHub API, which causes the CI jobs to fail, and the only
+known workaround is to simply re-run the job.
+
+This patch implements the `@octokit/plugin-throttling`[2] plugin and wires
+it up with the GitHub Octokit instance[3].
+
+This plugin is recommended by the Octokit docs[4] as it implements all
+the GitHub best practices for integrators[5].
+
+[1]: https://github.com/changesets/action/issues/192
+[2]: https://github.com/octokit/plugin-throttling.js
+[3]: https://github.com/actions/toolkit/blob/main/packages/github/src/github.ts#LL18C40-L18C40
+[4]: https://octokit.github.io/rest.js/v19#throttling
+[5]: https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28

package.json

@@ -10,7 +10,7 @@
  "fixturez": "^1.1.0",
  "parcel": "^1.12.3",
  "prettier": "^2.0.5",
- "typescript": "^3.5.3"
+ "typescript": "^5.0.4"
  },
  "scripts": {
  "build": "parcel build ./src/index.ts --no-source-maps --target=node --bundle-node-modules",
@@ -33,6 +33,7 @@
  "@changesets/pre": "^1.0.9",
  "@changesets/read": "^0.5.3",
  "@manypkg/get-packages": "^1.1.3",
+ "@octokit/plugin-throttling": "5.1.1",
  "@types/fs-extra": "^8.0.0",
  "@types/jest": "^24.0.18",
  "@types/node": "^12.7.1",
@@ -51,5 +52,8 @@
  "husky": {
  "hooks": {}
  },
- "prettier": {}
+ "prettier": {},
+ "resolutions": {
+ "**/@octokit/core": "4.2.0"
+ }
 }

src/run.ts

@@ -1,4 +1,5 @@
 import { exec, getExecOutput } from "@actions/exec";
+import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
 import * as github from "@actions/github";
 import fs from "fs-extra";
 import { getPackages, Package } from "@manypkg/get-packages";
@@ -14,6 +15,9 @@ import {
 import * as gitUtils from "./gitUtils";
 import readChangesetState from "./readChangesetState";
 import resolveFrom from "resolve-from";
+import { throttling } from "@octokit/plugin-throttling";
+// temporary workaround for https://github.com/octokit/plugin-throttling.js/pull/590
+import type {} from "@octokit/plugin-throttling/dist-types/types.d";
 
 // GitHub Issues/PRs messages have a max size limit on the
 // message body payload.
@@ -78,7 +82,38 @@ export async function runPublish({
  createGithubReleases,
  cwd = process.cwd(),
 }: PublishOptions): Promise<PublishResult> {
- let octokit = github.getOctokit(githubToken);
+ const octokit = new (GitHub.plugin(throttling))(
+ getOctokitOptions(githubToken, {
+ throttle: {
+ onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
+ console.log(
+ `Request quota exhausted for request ${options.method} ${options.url}`
+ );
+
+ if (retryCount <= 2) {
+ console.log(`Retrying after ${retryAfter} seconds!`);
+ return true;
+ }
+ },
+ onSecondaryRateLimit: (
+ retryAfter,
+ options: any,
+ octokit,
+ retryCount
+ ) => {
+ console.log(
+ `SecondaryRateLimit detected for request ${options.method} ${options.url}`
+ );
+
+ if (retryCount <= 2) {
+ console.log(`Retrying after ${retryAfter} seconds!`);
+ return true;
+ }
+ },
+ },
+ })
+ );
+
  let [publishCommand, ...publishArgs] = script.split(/\s+/);
 
  let changesetPublishOutput = await getExecOutput(