HomeAbout usSign up

av-pr(1)

NAME

av-pr - Create a pull request for the current branch

SYNOPSIS

av pr create [-t <title>| --title=<title>] [-b <body>| --body=<body>]
    [--draft] [--edit] [--force] [--no-push] [--reviewers=<reviewers>]
    [--submit] [--current] [--queue]

DESCRIPTION

Push the current branch and create a pull request if not exist. If the branch has a parent branch, you need to make a pull-request for the parent first. If title and body are not provided, $EDITOR pops up and you are asked to provide them.

When there's already a pull-request, the command just pushes the branch to remote, and you are not asked to provide the title and the body. If you want to edit the pull-request description for the existing pull-request, use --edit.

You can use the --all flag to submit pull requests for every branch in the current stack. Or you can use --all --current to submit pull requests up to the current branch. This will ensure every pull request has the correct base branch and includes the correct metadata in the pull request description. Existing pull requests will be updated accordingly.

OPTIONS

-t <title>, --title=<title> : Use the given <title> as the title for the pull request.

-b <body>, --body=<body> : Use the given <body> as the body for the pull request.

--draft : Create the pull request/s as a draft.

--edit : Edit the pull request title and description before submitting even if the pull request already exists.

--force : Force creation of a pull request even if there is already a pull request associated with this branch.

--no-push : Do not push the branch to the remote repository before creating the pull request.

--reviewers=<reviewers> : Add reviewers to the pull request. The value should be a comma-separated list of GitHub usernames or team names.

--all [--current] : Create pull requests for every branch in the current stack or up to the current branch.

--queue : Add an existing pull request for the current branch to the Aviator Merge Queue.

EXAMPLES

Create a pull request, specifying the body of the PR from standard input:

$ av pr --title "Implement fancy feature" --body - <<EOF
> Implement my very fancy feature.
> Can you please review it?
> EOF
Previousav-pr-status(1)Nextav-prev(1)

Last updated