You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-3Lines changed: 0 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -272,8 +272,6 @@ In addition, git-xargs includes several features and flags to help you:
272
272
273
273
git-xargs distinguishes between work that is safe to perform in parallel, such as certain git operations, and work that must be done with consideration of resource constraints, such as issuing open pull requests to GitHub's API. Therefore, git-xargs is able to perform all concurrency-safe work as quickly as possible by leveraging goroutines, while treating the more expensive open pull request API calls separately.
274
274
275
-
The `--max-concurrent-repos` flag allows you to specify the upper limit of concurrent goroutines that should be allowed to carry out concurrency-safe work.
276
-
277
275
Pull requests are handled on a separate channel so that they can be buffered and retried in accordance with rate limiting feedback git-xargs is receiving from GitHub's API.
278
276
279
277
This means that git-xargs performs all the work upfront that it can as quickly as possible, and then moves on to serially process the pull request jobs that have resulted from the concurrency-safe work of cloning repositories, making file changes, checking the git worktree, etc.
|`--skip-pull-requests`| If you don't want any pull requests opened, but would rather have your changes committed directly to your specified branch, pass this flag. Note that it won't work if your Github repo is configured with branch protections on the branch you're trying to commit directly to! Default: `false`. | Boolean | No |
417
415
| `--skip-archived-repos` | If you want to exclude archived (read-only) repositories from the list of targeted repos, pass this flag. Default: `false`. | Boolean | No |
418
416
| `--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 |
419
-
|`--max-concurrent-repos`| Limits the number of concurrent processed repositories. This is only useful if you encounter issues and need throttling when running on a very large number of repos. Default:`0` (Unlimited). | Integer | No |
420
417
|`--draft`| Whether to open pull requests in draft mode. Draft pull requests are available forpublic GitHub repositories and private repositoriesin 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 |
421
418
|`--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 |
422
419
|`--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 |
Usage: "The description to add to pull requests opened by git-xargs",
82
81
Value: DefaultPullRequestDescription,
83
82
}
84
-
GenericMaxConcurrentReposFlag= cli.IntFlag{
85
-
Name: MaxConcurrentReposFlagName,
86
-
Usage: "Limits the number of concurrent processed repositories. This is only useful if you encounter issues and need throttling when running on a very large number of repos. Default is 0 (Unlimited)",
87
-
Value: DefaultMaxConcurrentRepos,
88
-
}
89
83
GenericSecondsToWaitFlag= cli.IntFlag{
90
84
Name: SecondsToWaitBetweenPrsFlagName,
91
85
Usage: "The number of seconds to sleep between pull requests in order to respect GitHub API rate limits. Increase this number if you are being rate limited regularly. Defaults to 12 seconds.",
0 commit comments