Create a gist now

Instantly share code, notes, and snippets.

Checkout github pull requests locally

Locate the section for your github remote in the .git/config file. It looks like this:

[remote "origin"]
    fetch = +refs/heads/*:refs/remotes/origin/*
    url = git@github.com:joyent/node.git

Now add the line fetch = +refs/pull/*/head:refs/remotes/origin/pr/* to this section. Obviously, change the github url to match your project's URL. It ends up looking like this:

[remote "origin"]
    fetch = +refs/heads/*:refs/remotes/origin/*
    url = git@github.com:joyent/node.git
    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*

Now fetch all the pull requests:

$ git fetch origin
From github.com:joyent/node
 * [new ref]         refs/pull/1000/head -> origin/pr/1000
 * [new ref]         refs/pull/1002/head -> origin/pr/1002
 * [new ref]         refs/pull/1004/head -> origin/pr/1004
 * [new ref]         refs/pull/1009/head -> origin/pr/1009
...

To check out a particular pull request:

$ git checkout pr/999
Branch pr/999 set up to track remote branch pr/999 from origin.
Switched to a new branch 'pr/999'
@DTrejo
DTrejo commented Aug 13, 2012

LOVELY.

@chilts
chilts commented Aug 13, 2012

Hey cool. Didn't know you could do that! :) Thanks.

@sminnee
sminnee commented Aug 13, 2012

GENIUS!

@naholyr
naholyr commented Aug 14, 2012

So much love \o/

@AlekSi
AlekSi commented Aug 14, 2012

⭐️

@cordoval

thanks!

@johnnagro

⛵️

@mikaelkaron

awesome!

@cldwalker

Nice! I dropped this in my rc file to make this process easy:
function pullify() {
git config --add remote.origin.fetch '+refs/pull//head:refs/remotes/origin/pr/'
}

@piscisaureus
Owner

@cldwalker

Thanks. I just realized that with this trick you can enable it for all your repos at once :-)

git config --global --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"

@andhapp
andhapp commented Sep 27, 2012

Just for fetching only one pull request. Handy, if you're hacking on something.

  git fetch origin pull/7324/head:pr-7324

origin points to the remote server.
pull/7324/head is the remote pull request.
pr-7324 is the local pull-request branch.

@TrevorBurnham

@piscisaureus The global config trick has an unfortunate side-effect. See http://stackoverflow.com/questions/13572191/cannot-remove-remote-origin/. Might be worth the tradeoff, but it's worth being aware of.

@havvg
havvg commented Nov 27, 2012

Your refspec is wrong, isn't it?

[remote "origin"]
    fetch = +refs/heads/*:refs/remotes/origin/*
    url = git@github.com:joyent/node.git
    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*

In case you retrieve a branch named pr/3 from the origin fetched based on your first refspec +refs/heads/*:refs/remotes/origin/* and there is a third pull request, it would conflict. I never tried it, but that's why I got fetch = +refs/pull/*/head:refs/gh-pull/remotes/origin/* as refspec, which is not conflicting with anything of git.

On a side note, when building scripts imitating the "merge"-button of github, you can make use of fetch = +refs/pull/*/merge:refs/gh-merge/remotes/origin/* which point to the merge commit of the respective pull request.

@tomjenkinson

Anyone managed to work out how to actually remove the pull ref, for example:
git push origin :pr/1
doesn't seem to work

@pcreux
pcreux commented Jan 22, 2013

You can also use https://github.com/defunkt/hub and run git checkout https://github.com/defunkt/hub/pull/73

@arthurnn
arthurnn commented Feb 2, 2013

Any reason for, when I do
git fetch origin --prune
it creates the pr local branches and it deletes them right after?

output:

 * [new ref]         refs/pull/1/head -> origin/pr/1
 * [new ref]         refs/pull/2/head -> origin/pr/2
 x [deleted]         (none)     -> origin/pr/1
 x [deleted]         (none)     -> origin/pr/2
@jimi-c
jimi-c commented Feb 9, 2013

@tomjenkinson did you ever figure out a solution to deleting them remotely, or to at least ignore those that are closed?

@jasoncodes

@arthurnn The fetch line for pull requests needs to be before the one for heads. I wrote a small shell function to do this.

@robinsmidsrod

I just wanted to chime in and tell you about a tool I put together to work with pull requests from the command line.

I know it's been done before, but I wanted to take a slightly different approach.

It's here: http://github.com/robinsmidsrod/App-GitHubPullRequest

@sthulb
sthulb commented Mar 22, 2013

👍

@hlysig
hlysig commented Mar 25, 2013

awesome!

@ypandit
ypandit commented Mar 25, 2013

👍

@Darep
Darep commented Mar 25, 2013

❤️

@joelmccracken

The way I normally do this is just to add the other user as a remote:

git remote add other_user other_user_repo_url
git fetch other_user
git checkout -b other_user_branch other_user/branch

Nice, though!

@crucialfelix

ooh, I've been trying to figure this one out forever ! I strongly dislike just reading and clicking "merge this" without testing.

@whit537
whit537 commented Mar 25, 2013

🚀

@JohnMcLear

Thank you

@mwhite
mwhite commented Mar 25, 2013

You can also try https://github.com/splitbrain/git-pull-request which shows you a list of pull requests.

@whit537
whit537 commented Mar 25, 2013

For the record, pushing a locally-merged PR closed it in the GitHub UI.

@whit537
whit537 commented Mar 25, 2013

I get an error trying to set up the branch as a tracking branch:

$ git checkout pr/785
error: Not tracking: ambiguous information for ref refs/remotes/origin/pr/785
Switched to a new branch 'pr/785'
$

Indications are that it's because there are too many such branches?

@whit537
whit537 commented Mar 25, 2013

And also for the record, a fast-forward merge doesn't seem to close the PR in GitHub. That is, I rebased master onto pr/785, then merged pr/785 to master, then pushed, and the PR is still open.

@whit537
whit537 commented Mar 25, 2013

I hypothesize that rebasing meant that the original commit hash was lost, and GitHub looks at commit hashes to determine whether a PR is closed.

@whit537
whit537 commented Mar 25, 2013

I wonder if my broken tracking branch affects this as well?

@treyhunner

@whit537 I think you're right about rebase being the issue. Github looks only for the hashes in the original PR commits. A fast-forward vs. non-fast-forward shouldn't matter, but if a rebase changes the hashes it won't work.

@whit537
whit537 commented Mar 25, 2013

Per: http://mislav.uniqpath.com/2013/02/merge-vs-rebase/

It seems that git merge --no-ff pr/785 and git cherry-pick pr/785 might be good parts of a workflow that doesn't confuse GitHub.

@whit537
whit537 commented Mar 25, 2013

@treyhunner Ah, okay, thanks. :)

@whit537
whit537 commented Mar 25, 2013

fetch = +refs/pull/*/head:refs/remotes/origin/pr/*

So if I'm reading this right, it means that GitHub keeps pull requests in the pull namespace, ya?

@whit537
whit537 commented Mar 25, 2013

I get the same error message trying to fix up a tracking branch after the fact:

$ git branch --set-upstream-to=origin/pr/782
error: Not tracking: ambiguous information for ref refs/remotes/origin/pr/782
$
@jverkoey

Hellz yeah, thanks!

@whit537
whit537 commented Mar 25, 2013

Here's fetch:

$ git fetch
From github.com:gittip/www.gittip.com
 * [new ref]         refs/pull/100/head -> origin/pr/100
 * [new ref]         refs/pull/105/head -> origin/pr/105
 * [new ref]         refs/pull/117/head -> origin/pr/117
 * [new ref]         refs/pull/137/head -> origin/pr/137
[...]
 * [new ref]         refs/pull/782/head -> origin/pr/782
 * [new ref]         refs/pull/785/head -> origin/pr/785
 * [new ref]         refs/pull/788/head -> origin/pr/788
 * [new ref]         refs/pull/790/head -> origin/pr/790

And then:

$ git remote show origin
* remote origin
  Fetch URL: git@github.com:gittip/www.gittip.com.git
  Push  URL: git@github.com:gittip/www.gittip.com.git
  HEAD branch: master
  Remote branches:
    master                     tracked
    refs/pull/100/head         tracked
    refs/pull/105/head         tracked
    refs/pull/117/head         tracked
    refs/pull/137/head         tracked
[...]
    refs/pull/782/head         tracked
    refs/pull/785/head         tracked
    refs/pull/788/head         tracked
    refs/pull/790/head         tracked
    refs/remotes/origin/pr/100 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/105 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/117 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/137 stale (use 'git remote prune' to remove)
[...]
    refs/remotes/origin/pr/782 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/785 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/788 stale (use 'git remote prune' to remove)
    refs/remotes/origin/pr/790 stale (use 'git remote prune' to remove)
  Local branches configured for 'git pull':
    master   merges with remote master
  Local refs configured for 'git push':
    master            pushes to master            (up to date)

And then:

$ git remote prune origin
Pruning origin
URL: git@github.com:gittip/www.gittip.com.git
 * [pruned] origin/pr/100
 * [pruned] origin/pr/105
 * [pruned] origin/pr/117
 * [pruned] origin/pr/137
[...]
 * [pruned] origin/pr/782
 * [pruned] origin/pr/785
 * [pruned] origin/pr/788
 * [pruned] origin/pr/790

Bringing me back to:

* remote origin
  Fetch URL: git@github.com:gittip/www.gittip.com.git
  Push  URL: git@github.com:gittip/www.gittip.com.git
  HEAD branch: master
  Remote branches:
    master             tracked
    refs/pull/100/head new (next fetch will store in remotes/origin)
    refs/pull/105/head new (next fetch will store in remotes/origin)
    refs/pull/117/head new (next fetch will store in remotes/origin)
    refs/pull/137/head new (next fetch will store in remotes/origin)
[...]
    refs/pull/782/head new (next fetch will store in remotes/origin)
    refs/pull/785/head new (next fetch will store in remotes/origin)
    refs/pull/788/head new (next fetch will store in remotes/origin)
    refs/pull/790/head new (next fetch will store in remotes/origin)
    rubygems           tracked
  Local branches configured for 'git pull':
    master   merges with remote master
  Local refs configured for 'git push':
    master            pushes to master            (up to date)
@whit537
whit537 commented Mar 25, 2013
$ git --version
git version 1.8.1.3
$
@whit537
whit537 commented Mar 25, 2013

Got it! The heroku remote in my .git/config conflicts. Let's see how to configure for both ...

@whit537
whit537 commented Mar 25, 2013

Well, next thing:

$ git branch
  master
* pull/782
$
$ git pull
Your configuration specifies to merge with the ref 'pull/782'
from the remote, but no such ref was fetched.
$
@whit537
whit537 commented Mar 25, 2013

@jasoncodes's tip above about the order of the fetch refspecs takes the stale output out of git remote show origin.

@whit537
whit537 commented Mar 25, 2013

I fixed the heroku conflict by removing the fetch key in the [heroku] section of .git/config. Now it just looks like:

[remote "heroku"]                                                                             
    url = git@heroku.com:appname.git

I can still push to it just fine.

@dvessel
dvessel commented Mar 25, 2013

This is awesome!

Is it possible to filter for pull requests against a specific branch? thx!

::edit::

Never mind, doesn't look possible without it getting overly complicated. I wouldn't have gotten much out of it anyway.

@jfairley

👍

@marcelklehr

awesome! :)

@moltar
moltar commented Apr 1, 2013

Dope!! Thanks for the tip.

@pferreir
pferreir commented Apr 2, 2013

I cannot properly express all the love that this small piece of text musters in me. You have my gratitude.

@superbrothers

👍

@gnarf
gnarf commented Apr 17, 2013

You can create an alias to pull single pulls:

In your global .gitconfig:

[alias]
 pr = "!f() { git fetch origin refs/pull/$1/head:pr/$1; } ; f"

of course this always assumes origin because thats all I ever use for upstream when I'm a maintainer, but you can customize that part too if you want, relatively trivial

@rue
rue commented Apr 19, 2013

This is the best thing ever.

@sickill
sickill commented Apr 21, 2013

I'm trying to figure out what's the value of this? Since each PR is attached to a branch you can just checkout the branch, right?

@stubb
stubb commented May 2, 2013

@sickill not if someone forks your repo and works within this repo

@istro
istro commented May 3, 2013

Thank you @piscisaureus for the Gist!
However, for my purposes - @gnarf37 - your solution is more concise :-)

@franciscojunior

Today when I did git pull I got a lot of

 * [new ref]

But I didn't change anything in my .git/config. I thought those new refs would only be pulled if I added the line

fetch = +refs/pull/*/head:refs/remotes/origin/pr/*

Is my understanding correct or am I missing something? Thanks in advance for any information.

@obusher
obusher commented May 22, 2013

img

@LocutusOfBorg

Awesome!

@HBehrens
HBehrens commented Jul 2, 2013

Great, thanks :)

@gauteh
gauteh commented Jul 22, 2013

Modification of @cldwalker suggestion, ~/.gitconfig:

[alias]
pullify = config --add remote.origin.fetch '+refs/pull/*/head:refs/remotes/origin/pr/*'

or for arbitrary remotes use $1 for 'origin'.

@cavneb
cavneb commented Aug 9, 2013

Thanks!

@domenkozar

git checkout master curl https://github.com/project/repo/pulls/3.patch | git am

Done.

@whit537
whit537 commented Sep 3, 2013

@gnarf has some nice aliases at https://gist.github.com/gnarf/5406589.

$ git pr 537
From github.com:foo/bar
 * [new ref]         refs/pull/537/head -> pr/537
Switched to branch 'pr/537'
$ co master
Switched to branch 'master'
$ git pr-clean
Deleted branch pr/537 (was e17f10a).
$
@rmcastil
rmcastil commented Sep 9, 2013

thanks @piscisaureus!

@ricbermo

I prefer this method from @joelmccracken, Thanks, BTW.

git remote add other_user other_user_repo_url
git fetch other_user
git checkout -b other_user_branch other_user/branch

@tzz
tzz commented Jan 6, 2014

clever, thanks!

@thejameskyle

How would one add commits to a pr? With this:

git checkout pr/74
git commit -m 'Fixed some stuff'
git push origin pr/74

It creates a new branch pr/74

@blbradley

It would be superb if you could pull only open pull requests like this.

@pents90
pents90 commented Feb 7, 2014

@whit537, I' m getting the same issue as you (Your configuration specifies to merge with the ref 'pull/782'
from the remote, but no such ref was fetched), any idea how to fix?

@alexvbush

Somehow I get this:

git fetch origin
fatal: refs/remotes/origin/pr/40 tracks both refs/heads/pr/40 and refs/pull/40/head
Unexpected end of command stream

Any ideas what it might be?

@beporter

Is it possible for a maintainer to rebase a pull from a fork (instead of having to tell the originator of the PR to do it in their fork themselves?)

@richhollis

@JayMarshal - had the same problem and error message. I'd somehow managed to create a branch called pr/22. I verified this by seeing the branch in GitHub.

I used the following to delete the erroneous pr branch (from http://stackoverflow.com/questions/2003505/how-do-i-delete-a-git-branch-both-locally-and-remotely):

git push origin --delete pr/22

Everything now working correctly and I can pull again.

@MattiSG
MattiSG commented Feb 17, 2014

This gist breaks installing Homebrew

Sorry for shouting, lots of comments in here. Don't get me wrong: this won't break installing with brew, but this will break installing brew itself. Indeed, using this trick will give you brew issue #19436, and will probably break some other scripts.

Basically, if a repo does not yet have an origin set, the instruction from this gist will pretend it has. However, since it has no URL (which of course it couldn't, since we want it to be generic), no fetch can happen, but you also can't associate any new origin, since it already exists.

@dolmen
dolmen commented Mar 28, 2014

@beporter Yes, you can.
Just create a branch from the submitted branch: git checkout -b pr42-rebased pr/42 ; git rebase master.
As an alternative you can also just cherry-pick each commit of the pr.

@iapilgrim

It works

@haiy
haiy commented Jun 14, 2014

Sooo looooog....Greate.

@beedaan
beedaan commented Jun 24, 2014

Thank You!

@dakcarto
dakcarto commented Sep 2, 2014

@piscisaureus It appears @jasoncodes's note about the order of the fetch lines is correct, i.e.:

[remote "origin"]
    url = git@github.com:joyent/node.git
    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
    fetch = +refs/heads/*:refs/remotes/origin/*

If the PR fetch comes after the regular fetch, I end up with an ambiguous (and non-existent) remote tracking branch in SourceTree.app on Mac. After the reordering, as above, assigned remote tracking branch is accurate and pulling in new changes works (though I'm sure if the remote PR is rebased and force-pushed a new local branch will still need checked out, as per norm).

This may be specific to the way SourceTree auto-assigns a tracking branch, but nonetheless, works for me.

@matthiasbeyer

And also for the record, a fast-forward merge doesn't seem to close the PR in GitHub. That is, I rebased master onto pr/785, then merged pr/785 to master, then pushed, and the PR is still open.

This is a feature github is still missing: Recognizing fast-forward merges.

@frhd
frhd commented Nov 13, 2014

I love this shit.

@quickfur

Wow. Thanks for posting this!! Just what I needed to rescue a pull request whose original submitter had deleted the repository of, so there was no other reference to the commits.

@twiecki
twiecki commented Jan 1, 2015

This used to work fine but now I'm getting:

>>git pull origin
fatal: Cannot fetch both refs/pull/416/head and refs/heads/pr/416 to refs/remotes/origin/pr/416

Any idea?

EDIT: Turns out there was a remote branch named pr/416 I had to delete.

@chernjie
chernjie commented Feb 9, 2015

I did this so often that I wrote a tool to do it for me, hope you like it!
https://gist.github.com/chernjie/b16fe4dccf3f386d52ff

@njt1982
njt1982 commented Feb 9, 2015

Once I am on one of these PR branches, is there anyway to find out the name of the branch this PR was made from?

Eg, say I had a PR open for master..my_feature and I checkout out pr/123... Is there any git command to tell me that ref points to the HEAD of my_feature?

@colinpade

worked for me! Thanks for your efforts.

@livash
livash commented May 1, 2015

Thanks for this post. Super helpful.

@howtomakeaturn

You know what? You are both cool and awesome.
Thanks a lot.

@mhotan
mhotan commented Jun 10, 2015

👍

@facekapow

100 X 👍, Thanks!

@zldrq
zldrq commented Aug 1, 2015

never saw that coming!

@ava-dylang

In addition to

    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*/head

I recommend grabbing the merge ref as well:

    fetch = +refs/pull/*/merge:refs/remotes/origin/pr/*/merge

Merge refs are the merge result from your branch to your merge target, they contain an exact copy of what the tip of the master will become when merged (well exact spare for an author perhaps)

@rr-
rr- commented Sep 4, 2015

Can I use this to recover active pull requests from deleted forks?

@gibffe
gibffe commented Nov 3, 2015

nice one !

@dorian-marchal

Nice, thank you ❤️

@ahmadawais

I use a bash function for this

#
# Git Checkout a Pull Request locally.
#
# Usage: gfpr 8
# Where 8 is the number of pull request (can be found right after the PR's title).
# @author Ahmad Awais github.com/ahmadawais
#
function gfpr(){
  echo "${whitef}———————————————————${reset}"
    echo "${whiteb} ${blackf}0. Fetching the pull request...${reset}"

    git fetch origin pull/"${1}"/head:pull_"${1}"

    echo "${whiteb} ${blackf}1. PR fetched creating a branch...${reset}"

    git checkout pull_"${1}"

    echo "${whiteb} ${blackf}2. Checking out to a new PR branch...${reset}"

    echo "${greenb} ${blackf}3. PR Branch Created!!!${reset}"
  echo "${whitef}———————————————————${reset}"
}

@IngwiePhoenix

There needs to be something in upstream git that just...does that. or at least in github/hub :p

@sideshowbarker

@tomjenkinson & @jimi-c: About removing any remote pull ref from a github repo, I’m pretty sure you can’t. If you could, the way would be:

git push --delete origin refs/pull/1/head

…where 1 is of course the PR number for whatever pull ref you want to remove.

But if you try that, you’ll get a message saying something like:

! [remote rejected] refs/pull/1/head (deny updating a hidden ref)

…the reason being that the github remote refs/pull/ namespace is a (synthetic) read-only namespace.

@bf4
bf4 commented Jan 28, 2016

A stupid way to recover a commit that has been rebased and is now unreachable:

  1. Given unreachable commit https://github.com/org/repo/commits/332a2b9f43f1f8d7730e0a01356ea183dfadd470
  2. See if you can compare them to any earlier commit you have https://github.com/org/repo/compare/f571415f4da9cc28edc83242e353966677dabcd2...332a2b9f43f1f8d7730e0a01356ea183dfadd470
  3. Push your local commit up to a recovery branch git checkout f571415f4da9cc28edc83242e353966677dabcd2; git checkout -b recovery; git push origin recovery
  4. See the patch commits https://github.com/org/repo/compare/recovery...332a2b9f43f1f8d7730e0a01356ea183dfadd470.patch and download as recovery.patch (you could curl unless it's private so blah blah)
  5. Apply the patch commits and push up. git am recovery.patch && git push origin recovery
@emilio2hd

Thank you

@denysdovhan

Is there way to get only opened pull requests, not all? Because I don't wanna see already merged requests.

@brucechou1983

Thank you. It's helpful!

@alisniffer

Thank you. It's helpful!

@hayd
hayd commented Apr 27, 2016

@sideshowbarker (@tomjenkinson @jimi-c)

whilst pull is readonly, it seems you can remove from the heads.

git push --delete upstream refs/heads/pr/521

This seems to fix the issue for our team (the PR/branch has since been deleted... I'm hoping it won't come back).

@amirj700

Very Useful thanks.

@cvvs
cvvs commented Aug 12, 2016

👍

@njql007
njql007 commented Sep 1, 2016

This is useful, thank you!

@drupol
drupol commented Sep 13, 2016

Hi,

Thanks for the useful tip !
One drawback only, how to update it's local branch when someone added a commit to the pull request ?
I tried git pull in the local branch, but I got this error:

pol@localhost ~/d/g/mysite> git pull
Your configuration specifies to merge with the ref 'pr/4'
from the remote, but no such ref was fetched.
pol@localhost ~/d/g/mysite>
@ohdoking

oh so nice tip

@clemens-tolboom

Reading https://git-scm.com/book/en/v2/Git-Internals-The-Refspec I do not see a command to add this ***** refspecs

It seems one can fetch an individual PR by something like git fetch origin master:refs/remotes/origin/mymaster but I haven't figured out as adding the whole lot is much simpler as most of the time one is interested in more then one PR

@ryanchou1991

awesome job it could either checkout upstream pull requests.

@anhhh11
anhhh11 commented Oct 11, 2016

awesome \o/

@membphis

great job. thanks a lots

@mosheeshel

Is there any way to make the local branch track the remote branch the PT is based on?

@tucq88
tucq88 commented Nov 25, 2016 edited

First, thanks for this great gist. But second, I want to ask if anyone figure out a way to list only current opening PRs ? Listing all of them (include with closed PRs) is not very ...productive
@denysdovhan Did you find a way to do so ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment