Skip to content

Add the -fork flag to submit PRs from forks #77

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

Merged
bluekeyes merged 7 commits into from
Jan 9, 2024
Merged

Add the -fork flag to submit PRs from forks #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5defc15
Add permission warning on 404 errors
bluekeyes Jan 7, 2024
7dab92a
Define -fork and -fork-repository flags
bluekeyes Jan 7, 2024
e8c7c01
Add support for submitting PRs from forks
bluekeyes Jan 8, 2024
e977366
Fix type and remove debug code
bluekeyes Jan 8, 2024
6a0584f
Improve behavior when waiting for new forks
bluekeyes Jan 9, 2024
1d97380
Handle error when a fork already exists
bluekeyes Jan 9, 2024
839b126
Use commit listing to test for fork readiness
bluekeyes Jan 9, 2024
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
63 changes: 38 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,45 +64,58 @@ Usage: patch2pr [options] [patch]

Override the commit message by using the -message flag.

With the -fork and -fork-repository flags, the command can submit the pull
request from a fork repository. If an existing fork does not exist, the
command creates a new fork, which may take up to five minutes.

Options:

-base-branch=branch The branch to target with the pull request. If unset,
use the repository's default branch.
-base-branch=branch The branch to target with the pull request. If unset,
use the repository's default branch.

-draft Create a draft pull request.

-force Update the head branch even if it exists and is not a
fast-forward.

-draft Create a draft pull request.
-fork Submit the pull request from a fork instead of pushing
directly to the repository. With no other flags, use a
fork in the current account with the same name as the
target repository, creating the fork if it does not exist.

-force Update the head branch even if it exists and is not a
fast-forward.
-fork-repository=repo Submit the pull request from the named fork instead of
pushing directly to the repository, creating the fork
if it does not exist. Implies the -fork flag.

-head-branch=branch The branch to create or update with the new commit. If
unset, use 'patch2pr'.
-head-branch=branch The branch to create or update with the new commit. If
unset, use 'patch2pr'.

-json Output information about the new commit and pull request
in JSON format.
-json Output information about the new commit and pull request
in JSON format.

-message=message Message for the commit. Overrides the patch header.
-message=message Message for the commit. Overrides the patch header.

-no-pull-request Do not create a pull request after creating a commit.
-no-pull-request Do not create a pull request after creating a commit.

-patch-base=base Base commit to apply the patch to. Can be a SHA1, a
branch, or a tag. Branches and tags must start with
'refs/heads/' or 'refs/tags/' respectively. If unset,
use the repository's default branch.
-patch-base=base Base commit to apply the patch to. Can be a SHA1, a
branch, or a tag. Branches and tags must start with
'refs/heads/' or 'refs/tags/' respectively. If unset,
use the repository's default branch.

-pull-body=body The body for the pull request. If unset, use the body of
the commit message.
-pull-body=body The body for the pull request. If unset, use the body of
the commit message.

-pull-title=title The title for the pull request. If unset, use the title
of the commit message.
-pull-title=title The title for the pull request. If unset, use the title
of the commit message.

-repository=repo Repository to apply the patch to in 'owner/name' format.
Required.
-repository=repo Repository to apply the patch to in 'owner/name' format.
Required.

-token=token GitHub API token with 'repo' scope for authentication.
If unset, use the value of the GITHUB_TOKEN environment
variable.
-token=token GitHub API token with 'repo' scope for authentication.
If unset, use the value of the GITHUB_TOKEN environment
variable.

-url=url GitHub API URL. If unset, use https://api.github.com.
-url=url GitHub API URL. If unset, use https://api.github.com.
```

## Usage: Library
Expand Down
Loading