docs for ci-status

mislav · Apr 26, 2013 · daa0352 · daa0352
1 parent 04150b2
commit daa0352
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 5 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,7 @@
+## master
+
+* new `ci-status` command for checking GitHub Status API
+
 ## 1.10.6 (2013-04-25)
 
 * compensate for new GitHub API enforcement

diff --git a/README.md b/README.md
@@ -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)
 
 

diff --git a/man/hub.1 b/man/hub.1
@@ -1,7 +1,7 @@
 .\" 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

diff --git a/man/hub.1.html b/man/hub.1.html
diff --git a/man/hub.1.ronn b/man/hub.1.ronn
@@ -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