GitHub RubyGems

RubyGems is a package manager for Ruby. At GitHub, we've tried to make the process of building and releasing new gems as simple as possible. Please see the documentation below on how to use the system.

Installing a RubyGem from GitHub

Update to RubyGems 1.2.0 or greater before proceeding!!

  $ gem sources -a http://gems.github.com (you only have to do this once)
  $ sudo gem install username-projectname

Example Usage:

  $ sudo gem install defunkt-github
  Successfully installed defunkt-github-0.1.3
  $ irb -rubygems

(regular require)

>> require 'github'
=> true

(explicit require)

>> gem 'defunkt-github'
=> true
>> require 'github'
=> true

Hosting a RubyGem on GitHub

If you'd like to host your gem on Github, please do the following:

1. Create a new repository on GitHub if you haven't already.
2. Go to your project's edit page and check the 'RubyGem' box.
3. Add project_name.gemspec to the root directory. (example gemspec)
4. Push your gemspec to GitHub and we'll build a gem (prefixed with your username) on the fly.
5. Any time you push a gemspec with a bumped version number, we'll build a new gem for you.

Finding a Gem on GitHub

We publish an updated gem list every 15 minutes: http://gems.github.com/list.html

Troubleshooting

• If your gem isn't showing up, double-check that your 'RubyGem' checkbox is checked on your repo, it's really easy to forget this step.
• Verify your gemspec works prior to pushing by running the following:

  $ gem build project_name.gemspec

• Once you've pushed your gemspec to GitHub, it may take up to 15 minutes for your new gem to find its way into our index.
• We'll build a new version of the gem when you bump the version number you set in your gemspec.
• Gems will only be built when the gemspec version is bumped on the master branch.
• If your gem builds fine locally, but doesn't on GitHub, it's most likely a $SAFE problem. Run the following script to simulate our environment: Gist - 16215
• We recommend using Jeweler, a GitHub specific gemspec builder, to maintain your gemspec.
• If you're currently using Hoe to manage your gems, you can run 'rake debug_gem' to generate the gemspec.
• Report any bugs or feature requests to GitHub Support (include your gemspec and please remember to try and build the gem locally first).