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 for system usage.

Installing a RubyGem from GitHub

There have been issues reported using gem sources -a https://gems.github.com,
so please use the manual source install below until a resolution is found.

  $ sudo gem install username-projectname -s https://gems.github.com

Example Usage:

  $ sudo gem install mojombo-grit -s https://gems.github.com
  Successfully installed mojombo-grit-0.8.1
  $ irb -rubygems
  
  (regular require)
  >> require 'grit'
  => true
  
  (explicit require)
  >> gem 'mojombo-grit'
  => true
  >> require 'grit'
  => 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 subsequent changes you make to your gemspec, we'll build a new gem for you.

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 a few minutes for your new gem to find its way into our index.
• We'll build a new version of the gem or rebuild an existing version of the gem based upon the version you set in your gemspec.
• Gems will only be built when the gemspec is modified 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:

  require 'rubygems/specification'
  data = File.read('your-project.gemspec')
  spec = nil
  Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
  puts spec
      

• 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 Lighthouse (include your gemspec and please remember to try and build the gem locally first).