Skip to content

feat: Add Octokit Throttling to handle github rate limit/request throttling #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeffhubLR wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add Octokit Throttling to handle github rate limit/request throttling #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | |
| `milestone` | The number of the milestone to associate this pull request with. | |
| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
| `disable-throttling` | Disable Github-recommended throttle handling which utilizes [octokit/plugin-throttling.js](https://github.com/octokit/plugin-throttling.js). | `false` |
| `retry-attempts` | Number of times throttled attempts should be retried before failing. | 5 |
| `minimum-retry-after` | Minimum time in seconds to wait before retry. | 5 |

For self-hosted runners behind a corporate proxy set the `https_proxy` environment variable.
```yml
Expand Down
9 changes: 9 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ inputs:
draft:
description: 'Create a draft pull request'
default: false
disable-throttling:
description: 'Disable Github-recommended throttle handling'
default: false
retry-attempts:
description: 'Number of times throttled attempts should be retried before failing'
default: 10
minimum-retry-after:
description: 'Minimum time in seconds to wait before retry'
default: 10
outputs:
pull-request-number:
description: 'The pull request number'
Expand Down
Loading