‘" t ." Title: git-pull-req ." Author: [see the “AUTHOR” section] ." Generator: DocBook XSL Stylesheets v1.78.1 <docbook.sf.net/> ." Date: 04/20/2016 ." Manual: \ & ." Source: \ & ." Language: English ." .TH “GIT-PULL-REQ” “1” “04/20/2016” “\ &” “\ &” ." —————————————————————– ." * Define some portability stuff ." —————————————————————– ." ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ." bugs.debian.org/507673 ." lists.gnu.org/archive/html/groff/2009-02/msg00013.html ." ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie n(.g .ds Aq (aq .el .ds Aq ’ ." —————————————————————– ." * set default formatting ." —————————————————————– ." disable hyphenation .nh ." disable justification (adjust text to left margin only) .ad l ." —————————————————————– ." * MAIN CONTENT STARTS HERE * ." —————————————————————– .SH “NAME” git-pull-req - Creates or gets a GitHub pull request&. .SH “SYNOPSIS” .sp fIgit-pull-reqfR [fIOPTIONSfR] .sp fIgit-pull-reqfR [fIOPTIONSfR] fIpull_request_titlefR .sp fIgit-pull-reqfR [fIOPTIONSfR] [ fIserver/pull_request_numberfR | fIpull_request_numberfR ] .SH “DESCRIPTION” .sp fIgit-pull-req(1)fR creates or gets a pull request on the GitHub server associated with the current branch&. For the reasons why pull requests are useful for the development process, see help&.github&.com/articles/using-pull-requests .sp The fIgit-pull-req(1)fR command is a nice, simplified alternative to using the web interface that takes advantage of the conventions used in the rest of the fIgit-process(1)fR suite&. .sp If no name or number is provided, it is assumed that you want to create a new pull request with the same name as the current branch&. If a name is explicitly given, that is used instead&. .sp If a number is given, or a number with a server preceding it (e&.g&., “origin/23”), then this assumes that the number refers to an existing pull request identified by that number&. In that case, the branch associated with the HEAD of the pull request is checked out&. .sp The URL for the newly created pull request is shown, making it trivial to make any changes you want to it, such as adding additional notes&. (Most terminal programs allow you to “click through” a URL, though they all differ slightly in how&. For example, iTerm2 on OS X does it with a Cmd-Click&.) .sp The counterpart to this command is fIgit-to-master(1)fR&. .sp It(cqs assumed that you fBneverfR do any work directly on the integration branch: everything is done on a feature branch&. In addition to being a much safer and more flexible way of working in general, it is also a requirement to take advantage of same-repo pull request functionality&. .SH “OPTIONS” .sp The effective default is “fBgit pull-req -r -i -ffR”&. .PP fB-b <branch>, --base-branch <branch>fR .RS 4 The branch on the server that you want this “pulled” into&. See the fIgitProcess&.integrationBranchfR configuration item&. (fBdefault: the integration branchfR) .RE .PP fB-e <branch>, --head-branch <branch>fR .RS 4 The branch that you want reviewed before being “pulled” into the base branch&. (fBdefault: the current branchfR) .RE .PP fB-r <repo>, --repo-name <repo>fR .RS 4 The name of the repository to “pull” into&. See the fIgitProcess&.remoteNamefR configuration item&. (*default: the current repository) .RE .PP fB-d <desc>, --description <desc>fR .RS 4 The description of the Pull Request&. Usually includes a nice description of what was changed to make things easier for the reviewer&. .RE .PP fB-u <username>, --user <username>fR .RS 4 Your GitHub username&. Only needed the first time you connect, and you will be prompted for it if needed&. Used to generate the value for the fIgitProcess&.github&.authtokenfR configuration&. See also the fIgithub&.userfR configuration item&. .RE .PP fB-p <password>, --password <password>fR .RS 4 Your GitHub password&. Only needed the first time you connect, and you will be prompted for it if needed&. Used to generate the value for the fIgitProcess&.github&.authtokenfR configuration&. .RE .PP fB--infofR .RS 4 Informational messages; show the major things this is doing (fBdefault: truefR) .RE .PP fB-q, --quietfR .RS 4 Quiet messages; only show errors .RE .PP fB-v, --verbosefR .RS 4 Verbose messages; show lots of details on what this is doing .RE .PP fB--versionfR .RS 4 Print version and exit .RE .SH “CONFIGURATION” .sp Options for fIgit-sync(1)fR are set using fIgit-config(1)fR&. .PP fBgitProcess&.remoteNamefR .RS 4 Allows you to explicitly set the remote server name to use&. Defaults to the first server name reported by fIgit-remote(1)fR&. .RE .PP fBgitProcess&.integrationBranchfR .RS 4 Allows you to explicitly set the integration branch to use&. Defaults to “master”&. .RE .PP fBgitProcess&.github&.authtokenfR .RS 4 Not meant to be set manually, this is the OAuth token used to communicate with the GitHub server&. If it is not set, the user will be prompted for their credentials&. .RE .PP fBgithub&.userfR .RS 4 If OAuth needs to prompt for credentials, if this value is set then it is used as the username&. Otherwise it is unused&. .RE .SH “GITHUB SUPPORT” .sp To know which GitHub URL to use, the value of fIgitProcess&.remoteNamefR is resolved to the underlying server name/IP&. (That includes “aliased” names in a fIssh_config(5)fR file&.) If it(cqs github&.com, then the public GitHub&.com API is used&. Otherwise it(cqs assumed that the server is GitHub Enterprise and that set of URLs is used&. .SH “EXAMPLE” .sp You(cqve been developing your killer new feature or bug fix, and you want someone else to look at it (to do code-review or otherwise provide input)&. fIgit-pull-req(1)fR synchronizes the current branch with the server (effectively executing fIgit-sync(1)fR) and creates the pull request against the integration branch&. .SH “CONTROL FILES” .PP fBgitprocess-sync-fR*fB--fR* .RS 4 To help make the process simpler and more reliable, fIgit-pull-req(1)fR will put a file in the “fI&.gitfR” directory that contains the SHA-1 of the last successful sync to the server&. fIgit-to-master(1)fR will remove the file as part of its normal “housekeeping&.” .RE .SH “SEE ALSO” .sp fBgit-processfR(1), fBgit-to-masterfR(1), fBgit-new-fbfR(1), fBgit-syncfR(1) .SH “BUGS” .sp Known bug list: github&.com/jdigger/git-process/issues?state=open .SH “AUTHOR” .sp git-sync has been written primarily by Jim Moore&. .SH “RESOURCES” .sp Main web site: github&.com/jdigger/git-process