From de4dff05b1ef66131ddb001c1d976e6b806be4b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Burzy=C5=84ski?= Date: Sat, 6 May 2023 10:49:41 +0200 Subject: [PATCH] Update .changeset/rotten-carrots-pump.md --- .changeset/rotten-carrots-pump.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/.changeset/rotten-carrots-pump.md b/.changeset/rotten-carrots-pump.md index 7bc118e3..467d8e19 100644 --- a/.changeset/rotten-carrots-pump.md +++ b/.changeset/rotten-carrots-pump.md @@ -2,20 +2,9 @@ "@changesets/action": patch --- -add rate limit plugin for octokit +This patch implements the [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) plugin and [wires +it up with the internal GitHub Octokit instance](https://github.com/actions/toolkit/tree/457303960f03375db6f033e214b9f90d79c3fe5c/packages/github#extending-the-octokit-instance). -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 plugin is recommended by [the Octokit docs](://octokit.github.io/rest.js/v19#throttling) as it implements all the GitHub [best practices for integrators](https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28). -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 +This should help with `changesets/action` gitting spurious secondary rate limits and failing CI jobs, for which the only known workaround is to simply re-run the job.