Faster PR Pulls with Git Aliases

By  on  

I love the traditional GitHub workflow of receive pull request, pull down pull request to test, and merge the pull request.  GitHub makes the first and the third steps easy but pulling down pull requests from new contributors requires some boilerplate work that annoys me...

...namely navigating to their fork and copying the fork address so that I can do:

git pull https://github.com/some-new-user/repo.git branch-name

And since you don't know if the author will be contributing more in the future, there's no point in adding them as a remote (via git remote add) -- you'll just muddy up your remote listing.

After years of this annoying dance I've found TeamPorcupine's awesome git alias for easily pulling down pull requests:

git config --global --add alias.pr '!f() { git fetch -fu ${2:-upstream} refs/pull/$1/head:pr/$1 && git checkout pr/$1; }; f'

git config --global --add alias.pr-clean '!git checkout master ; git for-each-ref refs/heads/pr/* --format="%(refname)" | while read ref ; do branch=${ref#refs/heads/} ; git branch -D $branch ; done'

The first alias above, git pr, allows you to pull down a pull request by ID, creating an new branch for it:

~/Projects/debugger.html (master) $ git pr 4862
From https://github.com/devtools-html/debugger.html
 * [new ref]           refs/pull/4862/head -> pr/4862
Switched to branch 'pr/4862'

~/Projects/debugger.html (pr/4862) $

The second alias, git pr-clean, deletes all branches created with git pr:

~/Projects/debugger.html (pr/4862) $ git pr-clean
Switched to branch 'master'
Your branch is ahead of 'origin/master' by 190 commits.
  (use "git push" to publish your local commits)
husky > npm run -s postcheckout (node v8.5.0)

Deleted branch pr/4862 (was 10fe5049).
~/Projects/debugger.html (master) $

Note: You must have a remote called upstream which points to the upstream repo.

I can't tell you how happy I am to have this pr git alias, and how much of a bonus the pr-clean alias is.  Checking out PRs will be so much faster and I can focus more on code and functional review than process!

Recent Features

Incredible Demos

  • By
    MooTools & Printing – Creating a Links Table of Contents

    One detail we sometimes forget when considering print for websites is that the user cannot see the URLs of links when the page prints. While showing link URLs isn't always important, some websites could greatly benefit from doing so. This tutorial will show you...

  • By
    jQuery Chosen Plugin

    Without a doubt, my least favorite form element is the SELECT element.  The element is almost unstylable, looks different across platforms, has had inconsistent value access, and disaster that is the result of multiple=true is, well, a disaster.  Needless to say, whenever a developer goes...

Discussion

  1. I’m using git-extras, I totally recommend it!

  2. “hub” by Github is great for this sort of thing: https://hub.github.com/

  3. hozefa

    How do you then pull new commits added to the PR?

  4. Hi! Thanks for sharing this great git alias!

    One question: why not use origin instead of the upstream remote?

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!