diff --git a/README.md b/README.md index 93c6683..f9e88aa 100644 --- a/README.md +++ b/README.md @@ -271,7 +271,7 @@ git-xargs attempts to be a good citizen as regards consumption of the GitHub API In addition, git-xargs includes several features and flags to help you: 1. run jobs without tripping GitHub's rate limits -1. recover when rate limited by automatically re-trying failed pull requests again, all while honoring the GitHub rate limits +1. recover when rate limited by automatically retrying failed pull requests again, all while honoring the GitHub rate limits **Distinct processing channels for expensive and non-expensive work** @@ -283,7 +283,7 @@ This means that git-xargs performs all the work upfront that it can as quickly a **Automatic pull request retries when rate limited** -By default, git-xargs will re-attempt opening a pull request that failed due to rate limiting. The `--max-pull-request-retries` flag allows you to specify how many times you'd like a given pull request to be re-attempted in case of failure due to rate limiting. By default, the value is `3`, meaning that if you do not pass this flag, `git-xargs` will retry all rate-limit-blocked pull requests 3 times. +By default, git-xargs will re-attempt opening a pull request that failed due to rate limiting. The `--max-pr-retries` flag allows you to specify how many times you'd like a given pull request to be re-attempted in case of failure due to rate limiting. By default, the value is `3`, meaning that if you do not pass this flag, `git-xargs` will retry all rate-limit-blocked pull requests 3 times. **Automatic backoff when rate limiting is detected** @@ -421,7 +421,7 @@ echo "gruntwork-io/terragrunt gruntwork-io/terratest" | git-xargs \ | `--dry-run` | If you are in the process of testing out `git-xargs` or your initial set of targeted repos, but you don't want to make any changes via the Github API (pushing your local changes or opening pull requests) you can pass the dry-run flag. This is useful because the output report will still tell you which repos would have been affected, without actually making changes via the Github API to your remote repositories. Default: `false`. | Boolean | No | | `--draft` | Whether to open pull requests in draft mode. Draft pull requests are available for public GitHub repositories and private repositories in GitHub tiered accounts. See [Draft Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) for more details. Default: false. | Boolean | No | | `--seconds-between-prs` | The number of seconds to wait between opening serial pull requests. If you are being rate limited, continue to increase this value until rate limiting eases. Note, this value cannot be negative, so if you pass a value less than 1, the seconds to wait between pull requests will be set to 1 second. Default: `1` second. | Integer | No | -| `--max-pr-retries` | The number of seconds to wait between opening serial pull requests. If you are being rate limited, continue to increase this value until rate limiting eases. Default: `3` seconds. | Integer | No | +| `--max-pr-retries` | The number of times to retry a pull request that failed due to rate limiting. Default: `3`. | Integer | No | | `--seconds-to-wait-when-rate-limited` | The number of seconds to pause once git-xargs has detected it has been rate limited. Note that this buffer is in addition to the value of --seconds-between-prs. If you are regularly being rate limited, increase this value until rate limiting eases. Default: `60` seconds. | Integer | No | | `--no-skip-ci` | By default, git-xargs will prepend \"[skip ci]\" to its commit messages to prevent large git-xargs jobs from creating expensive CI jobs excessively. If you pass the `--no-skip-ci` flag, then git-xargs will not prepend \"[skip ci]\". Default: false, meaning that \"[skip ci]\" will be prepended to commit messages. | Bool | No | | `--reviewers` | An optional slice of GitHub usernames, separated by commas, to request reviews from after a pull request is successfully opened. Default: empty slice, meaning that no reviewers will be requested. | String | No | diff --git a/common/common.go b/common/common.go index 34d9810..8f002ca 100644 --- a/common/common.go +++ b/common/common.go @@ -97,7 +97,7 @@ var ( } GenericMaxPullRequestRetriesFlag = cli.IntFlag{ Name: MaxPullRequestRetriesFlagName, - Usage: "The number of times to re-try a failed pull request. Defaults to 3.", + Usage: "The number of times to retry a pull request that failed due to rate limiting. Defaults to 3.", Value: DefaultMaxPullRequestRetries, } GenericSecondsToWaitWhenRateLimitedFlag = cli.IntFlag{