GH

Bash utilities for Github, primarily with a Ruby perspective. Helps aid in releasing gems (including pushing builds to Gemcutter), viewing commits made from the last tag, and much more.

Installation

$ sudo make install
$ sudo make uninstall

Or if you do not wish to clone this repo:

$ cd /tmp && git clone git://github.com/visionmedia/gh.git && cd gh && sudo make install

gh update

• Auto-updates this library

gh init <project>

• Initializes a git project in the current directory
• Commits the current contents with 'Initial commit'
• Adds the remote repository on github as 'origin'
• Pushes master to origin
• See: gh init-remote
• (useful for new git repos)

gh init-remote <project>

• Adds the remote repository on github as 'origin'
• Pushes master to origin
• (useful for existing git repos)

gh clone <user> <project> [dest]

• Clones <user>'s public repo for <project>
• Or if your the owner, clones the private repo so you can push changes
• Ex: gh clone visionmedia jspec

gh remote <user> [project]

• Adds the <user>'s fork of your current gem as the remote named <user>
• When [project] is present then that project name will be used (useful for when project is not a ruby gem)
• Ex: gh remote visionmedia
• Ex: gh remote visionmedia jspec

gh submodule <user> <project> <dest>

• Creates a submodule for the given user's public project
• Ex: gh submodule visionmedia jspec support/jspec

gh open <project> [page]

• Opens Safari to your github <project> with optional [page]
• Ex: gh open jspec issues
• Ex: gh open jspec graphs/traffic

gh history

• Detects history file (changes, changelog, history, etc)
• Release heading (example shown below)
• Prepends gh latest-commits
• Opens in $EDITOR and --waits to be finished (so additional commands may follow)

• Ex: gh history && gh release 0.2.0

  n.n.n / YYYY-MM-DD

  • Commit a
  • Commit b
  • Commit c

gh docs <user> <project>

• Opens Safari to view RDocs for <user>'s <project>
• Ex: gh docs visionmedia commander

gh latest-commits

• Outputs list of commits since latest-version
• (useful for populating your changelog)

gh release <tag>

• Builds manifest / gemspec (via rake)
• Commits 'Release <tag>'
• Tags and pushes the branch and --tags to github
• Pushes to gemcutter
• Ex: gh release 1.0.2
• See: gh tag
• See: gh publish

gh tag <tag>

• Commits 'Release <tag>'
• Tags and pushes the brach and --tags to github

gh publish

• Build the current gemspec and release to Gemcutter

gh version

• Outputs the current version of your project

gh help

• Outputs the help information

License

(The MIT License)

Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, an d/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.