Implement git-pr

2026-09-10 07:26:17 -04:00 · 2014-10-07 12:50:59 +08:00 · 2014-10-07 12:50:59 +08:00 · ab67327ec0
parent 53470fa7ad
commit ab67327ec0
6 changed files with 305 additions and 0 deletions
--- a/Readme.md
+++ b/Readme.md
@ -71,6 +71,7 @@ $ brew install git-extras
 - `git lock`
 - `git unlock`
 - `git reset-file`
+ - `git pr`

 ## git-extras

@ -668,3 +669,14 @@ or reset one file to certain commit
 ```bash
 $ git reset-file .htaccess dc82b19
 ```
+
+## git-pr [number]
+
+Checks out a pull request from GitHub
+
+```bash
+$ git pr 226
+From https://github.com/visionmedia/git-extras
+ * [new ref]       refs/pulls/226/head -> pr/226
+Switched to branch 'pr/226'
+```
--- a/bin/git-pr
+++ b/bin/git-pr
@ -0,0 +1,11 @@
+#!/bin/sh
+# Based on https://gist.github.com/gnarf/5406589
+
+if test "$1" = "clean"; then
+  git for-each-ref refs/heads/pr/* --format='%(refname)' | while read ref; do
+    git branch -D ${ref#refs/heads/}
+  done
+else
+  test -z $1 && echo "pr number required." 1>&2 && exit 1
+  git fetch -fu ${2:-origin} refs/pull/$1/head:pr/$1 && git checkout pr/$1
+fi
--- a/man/git-pr.1
+++ b/man/git-pr.1
@ -0,0 +1,82 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GIT\-PR" "1" "October 2014" "" "Git Extras"
+.
+.SH "NAME"
+\fBgit\-pr\fR \- Checks out a pull request locally
+.
+.SH "SYNOPSIS"
+\fBgit\-pr\fR <number> [<remote>]
+.
+.br
+\fBgit\-pr clean\fR
+.
+.SH "DESCRIPTION"
+Creates a local branch based on a GitHub pull request number, and switch to that branch afterwards\.
+.
+.SH "OPTIONS"
+<remote>
+.
+.P
+The name of the remote to fetch from\. Defaults to \fBorigin\fR\.
+.
+.SH "EXAMPLES"
+This checks out the pull request \fB226\fR from \fBorigin\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ git pr 226
+
+remote: Counting objects: 12, done\.
+remote: Compressing objects: 100% (9/9), done\.
+remote: Total 12 (delta 3), reused 9 (delta 3)
+Unpacking objects: 100% (12/12), done\.
+From https://github\.com/visionmedia/git\-extras
+ * [new ref]         refs/pull/226/head \-> pr/226
+
+Switched to branch \'pr/226\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This pulls from a different remote:
+.
+.IP "" 4
+.
+.nf
+
+$ git pr 226 upstream
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To clean up old branches:
+.
+.IP "" 4
+.
+.nf
+
+$ git pr clean
+
+Deleted branch pr/226 (was b96a8c2)\.
+Deleted branch pr/220 (was d34dc0f)\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+Originally from https://gist\.github\.com/gnarf/5406589
+.
+.SH "REPORTING BUGS"
+<\fIhttps://github\.com/visionmedia/git\-extras/issues\fR>
+.
+.SH "SEE ALSO"
+<\fIhttps://github\.com/visionmedia/git\-extras\fR>
--- a/man/git-pr.html
+++ b/man/git-pr.html
@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>git-pr(1) - Checks out a pull request locally</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>git-pr(1)</li>
+    <li class='tc'>Git Extras</li>
+    <li class='tr'>git-pr(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>git-pr</code> - <span class="man-whatis">Checks out a pull request locally</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>git-pr</code> &lt;number&gt; [&lt;remote&gt;]<br />
+<code>git-pr clean</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>  Creates a local branch based on a GitHub pull request number, and switch to
+  that branch afterwards.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>  &lt;remote&gt;</p>
+
+<p>  The name of the remote to fetch from. Defaults to <code>origin</code>.</p>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>This checks out the pull request <code>226</code> from <code>origin</code>:</p>
+
+<pre><code>$ git pr 226
+
+remote: Counting objects: 12, done.
+remote: Compressing objects: 100% (9/9), done.
+remote: Total 12 (delta 3), reused 9 (delta 3)
+Unpacking objects: 100% (12/12), done.
+From https://github.com/visionmedia/git-extras
+ * [new ref]         refs/pull/226/head -&gt; pr/226
+
+Switched to branch 'pr/226'
+</code></pre>
+
+<p>This pulls from a different remote:</p>
+
+<pre><code>$ git pr 226 upstream
+</code></pre>
+
+<p>To clean up old branches:</p>
+
+<pre><code>$ git pr clean
+
+Deleted branch pr/226 (was b96a8c2).
+Deleted branch pr/220 (was d34dc0f).
+</code></pre>
+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Originally from https://gist.github.com/gnarf/5406589</p>
+
+<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
+
+<p>&lt;<a href="https://github.com/visionmedia/git-extras/issues" data-bare-link="true">https://github.com/visionmedia/git-extras/issues</a>&gt;</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>&lt;<a href="https://github.com/visionmedia/git-extras" data-bare-link="true">https://github.com/visionmedia/git-extras</a>&gt;</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2014</li>
+    <li class='tr'>git-pr(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>
--- a/man/git-pr.md
+++ b/man/git-pr.md
@ -0,0 +1,56 @@
+git-pr(1) -- Checks out a pull request locally
+=================================
+
+## SYNOPSIS
+
+`git-pr` &lt;number&gt; [&lt;remote&gt;]<br>
+`git-pr clean`
+
+## DESCRIPTION
+
+  Creates a local branch based on a GitHub pull request number, and switch to 
+  that branch afterwards.
+
+## OPTIONS
+  
+  &lt;remote&gt;
+
+  The name of the remote to fetch from. Defaults to `origin`.
+
+## EXAMPLES
+
+This checks out the pull request `226` from `origin`:
+
+    $ git pr 226
+
+    remote: Counting objects: 12, done.
+    remote: Compressing objects: 100% (9/9), done.
+    remote: Total 12 (delta 3), reused 9 (delta 3)
+    Unpacking objects: 100% (12/12), done.
+    From https://github.com/visionmedia/git-extras
+     * [new ref]         refs/pull/226/head -> pr/226
+
+    Switched to branch 'pr/226'
+
+This pulls from a different remote:
+
+    $ git pr 226 upstream
+
+To clean up old branches:
+
+    $ git pr clean
+  
+    Deleted branch pr/226 (was b96a8c2).
+    Deleted branch pr/220 (was d34dc0f).
+
+## AUTHOR
+
+Originally from https://gist.github.com/gnarf/5406589
+
+## REPORTING BUGS
+
+&lt;<https://github.com/visionmedia/git-extras/issues>&gt;
+
+## SEE ALSO
+
+&lt;<https://github.com/visionmedia/git-extras>&gt;
--- a/man/index.txt
+++ b/man/index.txt
@ -24,6 +24,7 @@ git-info(1)                   git-info
 git-local-commits(1)          git-local-commits
 git-lock(1)                   git-lock
 git-missing(1)                git-missing
+git-pr(1)                     git-pr
 git-rebase-patch(1)           git-rebase-patch
 git-refactor(1)               git-refactor
 git-release(1)                git-release