hub-pull-request(1)

1hub-pull-request(1)               hub manual               hub-pull-request(1)
2
3
4

NAME

6       hub-pull-request - Create a GitHub Pull Request.
7

SYNOPSIS

9       hub pull-request [-focpd] [-b BASE] [-h HEAD] [-r REVIEWERS ] [-a
10       ASSIGNEES] [-M MILESTONE] [-l LABELS]
11       hub pull-request -m MESSAGE [--edit]
12       hub pull-request -F FILE [--edit]
13       hub pull-request -i ISSUE
14

OPTIONS

16       -f, --force
17           Skip the check for unpushed commits.
18
19       -m, --message MESSAGE
20           The text up to the first blank line in MESSAGE is treated as the
21           pull request title, and the rest is used as pull request
22           description in Markdown format.
23
24           If multiple MESSAGE options are given, their values are
25           concatenated as separate paragraphs.
26
27       --no-edit
28           Use the message from the first commit on the branch as pull request
29           title and description without opening a text editor.
30
31       -F, --file FILE
32           Read the pull request title and description from FILE.
33
34       -e, --edit
35           Further edit the contents of FILE in a text editor before
36           submitting.
37
38       -i, --issue ISSUE
39           Convert ISSUE (referenced by its number) to a pull request.
40
41           You can only convert issues authored by you or that which you have
42           admin rights over. In most workflows it is not necessary to convert
43           issues to pull requests; you can simply reference the original
44           issue in the body of the new pull request.
45
46       -o, --browse
47           Open the new pull request in a web browser.
48
49       -c, --copy
50           Put the URL of the new pull request to clipboard instead of
51           printing it.
52
53       -p, --push
54           Push the current branch to HEAD before creating the pull request.
55
56       -b, --base BASE
57           The base branch in the "[OWNER:]BRANCH" format. Defaults to the
58           default branch of the upstream repository (usually "master").
59
60           See the "CONVENTIONS" section of hub(1) for more information on how
61           hub selects the defaults in case of multiple git remotes.
62
63       -h, --head HEAD
64           The head branch in "[OWNER:]BRANCH" format. Defaults to the
65           currently checked out branch.
66
67       -r, --reviewer USERS
68           A comma-separated list of GitHub handles to request a review from.
69
70       -a, --assign USERS
71           A comma-separated list of GitHub handles to assign to this pull
72           request.
73
74       -M, --milestone NAME
75           The milestone name to add to this pull request. Passing the
76           milestone number is deprecated.
77
78       -l, --labels LABELS
79           Add a comma-separated list of labels to this pull request. Labels
80           will be created if they do not already exist.
81
82       -d, --draft
83           Create the pull request as a draft.
84

EXAMPLES

86           $ hub pull-request
87           [ opens a text editor for writing title and message ]
88           [ creates a pull request for the current branch ]
89
90           $ hub pull-request --base OWNER:master --head MYUSER:my-branch
91           [ creates a pull request with explicit base and head branches ]
92
93           $ hub pull-request --browse -m "My title"
94           [ creates a pull request with the given title and opens it in a browser ]
95
96           $ hub pull-request -F - --edit < path/to/message-template.md
97           [ further edit the title and message received on standard input ]
98

CONFIGURATION

100       HUB_RETRY_TIMEOUT
101           The maximum time to keep retrying after HTTP 422 on --push
102           (default: 9).
103

NAME

SYNOPSIS

OPTIONS

EXAMPLES

CONFIGURATION

SEE ALSO