public
Last active

Checkout github pull requests locally

  • Download Gist
pr.md
Markdown

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'

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

So much love \o/

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/'

}

@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/*"

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.

@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.

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.

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

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

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

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

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

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

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!

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

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

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

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?

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.

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.

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

@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.

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.

@treyhunner Ah, okay, thanks. :)

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?

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
$

Hellz yeah, thanks!

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)
$ git --version
git version 1.8.1.3
$

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

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.
$

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

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.

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.

Dope!! Thanks for the tip.

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

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

This is the best thing ever.

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?

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

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

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.

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'.


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

Done.

@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).
$

thanks @piscisaureus!

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

clever, thanks!

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

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

@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?

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?

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?)

@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.

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.

@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.

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.