提交 daa0352d 编写于 作者: M Mislav Marohnić

docs for `ci-status`

上级 04150b21
## master
* new `ci-status` command for checking GitHub Status API
## 1.10.6 (2013-04-25)
* compensate for new GitHub API enforcement
......
......@@ -337,8 +337,8 @@ superpowers:
### git ci-status
$ hub ci-status
> (prints commit ci state and exits with exitcode)
$ hub ci-status [commit]
> (prints CI state of commit and exits with appropriate code)
> One of: success (0), error (1), failure (1), pending (2), no status (3)
......
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "HUB" "1" "March 2013" "DEFUNKT" "Git Manual"
.TH "HUB" "1" "April 2013" "DEFUNKT" "Git Manual"
.
.SH "NAME"
\fBhub\fR \- git + hub = github
......@@ -63,6 +63,9 @@
.br
\fBgit pull\-request\fR [\fB\-f\fR] [\fITITLE\fR|\fB\-i\fR \fIISSUE\fR] [\fB\-b\fR \fIBASE\fR] [\fB\-h\fR \fIHEAD\fR]
.
.br
\fBgit ci\-status\fR [\fICOMMIT\fR]
.
.SH "DESCRIPTION"
hub enhances various git commands to ease most common workflows with GitHub\.
.
......@@ -151,6 +154,13 @@ If \fITITLE\fR is omitted, a text editor will open in which title and body of th
.IP
If instead of normal \fITITLE\fR an issue number is given with \fB\-i\fR, the pull request will be attached to an existing GitHub issue\. Alternatively, instead of title you can paste a full URL to an issue on GitHub\.
.
.TP
\fBgit ci\-status\fR [\fICOMMIT\fR]
Looks up the SHA for \fICOMMIT\fR in GitHub Status API and displays the latest status\. Exits with one of:
.
.br
success (0), error (1), failure (1), pending (2), no status (3)
.
.SH "CONFIGURATION"
Hub will prompt for GitHub username & password the first time it needs to access the API and exchange it for an OAuth token, which it saves in "~/\.config/hub"\.
.
......@@ -430,6 +440,16 @@ $ hub submodule add \-b ryppl \-\-name pip ryppl/pip vendor/pip
.
.fi
.
.SS "git ci\-status"
.
.nf
$ hub ci\-status [commit]
> (prints CI state of commit and exits with appropriate code)
> One of: success (0), error (1), failure (1), pending (2), no status (3)
.
.fi
.
.SS "git help"
.
.nf
......
......@@ -100,7 +100,8 @@
<code>git browse</code> [<code>-u</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>] [SUBPAGE]<br />
<code>git compare</code> [<code>-u</code>] [<var>USER</var>] [<var>START</var>...]<var>END</var><br />
<code>git fork</code> [<code>--no-remote</code>]<br />
<code>git pull-request</code> [<code>-f</code>] [<var>TITLE</var>|<code>-i</code> <var>ISSUE</var>] [<code>-b</code> <var>BASE</var>] [<code>-h</code> <var>HEAD</var>]</p>
<code>git pull-request</code> [<code>-f</code>] [<var>TITLE</var>|<code>-i</code> <var>ISSUE</var>] [<code>-b</code> <var>BASE</var>] [<code>-h</code> <var>HEAD</var>]<br />
<code>git ci-status</code> [<var>COMMIT</var>]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
......@@ -191,6 +192,9 @@ the pull request can be entered in the same manner as git commit message.</p>
<p>If instead of normal <var>TITLE</var> an issue number is given with <code>-i</code>, the pull
request will be attached to an existing GitHub issue. Alternatively, instead
of title you can paste a full URL to an issue on GitHub.</p></dd>
<dt><code>git ci-status</code> [<var>COMMIT</var>]</dt><dd><p>Looks up the SHA for <var>COMMIT</var> in GitHub Status API and displays the latest
status. Exits with one of:<br />
success (0), error (1), failure (1), pending (2), no status (3)</p></dd>
</dl>
......@@ -415,6 +419,13 @@ $ hub submodule add -b ryppl --name pip ryppl/pip vendor/pip
&gt; git submodule add -b ryppl --name pip git://github.com/ryppl/pip.git vendor/pip
</code></pre>
<h3 id="git-ci-status">git ci-status</h3>
<pre><code>$ hub ci-status [commit]
&gt; (prints CI state of commit and exits with appropriate code)
&gt; One of: success (0), error (1), failure (1), pending (2), no status (3)
</code></pre>
<h3 id="git-help">git help</h3>
<pre><code>$ git help
......@@ -440,7 +451,7 @@ $ git help hub
<ol class='man-decor man-foot man foot'>
<li class='tl'>DEFUNKT</li>
<li class='tc'>March 2013</li>
<li class='tc'>April 2013</li>
<li class='tr'>hub(1)</li>
</ol>
......
......@@ -28,6 +28,7 @@ hub(1) -- git + hub = github
`git compare` [`-u`] [<USER>] [<START>...]<END>
`git fork` [`--no-remote`]
`git pull-request` [`-f`] [<TITLE>|`-i` <ISSUE>] [`-b` <BASE>] [`-h` <HEAD>]
`git ci-status` [<COMMIT>]
## DESCRIPTION
......@@ -151,6 +152,11 @@ hub also adds some custom commands that are otherwise not present in git:
request will be attached to an existing GitHub issue. Alternatively, instead
of title you can paste a full URL to an issue on GitHub.
* `git ci-status` [<COMMIT>]:
Looks up the SHA for <COMMIT> in GitHub Status API and displays the latest
status. Exits with one of:
success (0), error (1), failure (1), pending (2), no status (3)
## CONFIGURATION
Hub will prompt for GitHub username & password the first time it needs to access
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册