Optionally limit the number of PRs created in each submission #824
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, when submitting a PR in Sapling, it's easy to accidentally create multiple PRs when only one was intended (e.g. forgetting to run `sl pr follow`, or editing a PR that is based off a different branch). With this change, you can configure Sapling to limit the number of PRs that can be created in a single submit action, e.g. to just 1: ``` sl config --user github.max-prs-to-create=1 ``` Now when attempting to create multiple PRs in a single `sl pr submit` action, Sapling will fail with: ``` abort: refused to create 2 pull requests, max is 1 ```
|
@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
vegerot
reviewed
Jan 24, 2024
Comment on lines
181
to
182
| _("refused to create %d pull requests, max is %d") | ||
| % (len(params.pull_requests_to_create), max_pull_requests_to_create) |
There was a problem hiding this comment.
nit:
Suggested change
| _("refused to create %d pull requests, max is %d") | |
| % (len(params.pull_requests_to_create), max_pull_requests_to_create) | |
| _("refused to create %d pull requests, max is %d\nif you want to open %d pull requests, run again with `--config github.max-prs-to-create=-1") | |
| % (len(params.pull_requests_to_create), max_pull_requests_to_create, len(params.pull_requests_to_create) ) | |
There was a problem hiding this comment.
Thanks for the suggestion!
I've updated the PR, and (following our discussion on Discord) set the default value to 5.
Still open to further feedback of course.
Also update error message to explain how to create more than 5 PRs in one command.
|
@rejc2 has updated the pull request. You must reimport the pull request before landing. |
|
@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
This pull request has been merged in e62f3e8. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Optionally limit the number of PRs created in each submission
Currently, when submitting a PR in Sapling, it's easy to accidentally create multiple PRs when only one was intended (e.g. forgetting to run
sl pr follow, or editing a PR that is based off a different branch).With this change, you can configure Sapling to limit the number of PRs that can be created in a single submit action, e.g. to just 1:
Now when attempting to create multiple PRs in a single
sl pr submitaction, Sapling will fail with:(Note that this setting doesn't limit the size of a PR stack: a larger PR stack can be made by submitting each new PR separately. Re-submitting the top PR will still update the entire stack below it, no matter the size.)
Based on feedback and discussion, I've set the default for
github.max-prs-to-createto be 5.