Tumblelog by Soup.io
Newer posts are loading.
You are at the newest post.
Click here to check if anything new just came in.

July 20 2010

22:06

How to Get Started With Github and Release a Gem Using Jeweler

Ruby logoThese are quick notes I’m sharing with the NYC Ruby Women’s group, which I organize. One of my developer friends, Peter Harkins, recommended I share them with the world at large, so here they are.

More about Ruby and the NYC Ruby Women’s group in a bit.

SOME HELPFUL LINKS
http://rubygems.org – official repository
http://ruby-toolbox.com/ – shows the most popular Ruby gems (how many people who’ve looked at it, how many have downloaded it, how many have forked it)
http://railsplugins.org/ – compatibility tracking of plugins and gems (What works with various version of Ruby and Rails 3)

SOME HELPFUL RUBY COMMANDS:
gem update –system – updates all gems on in your system
gem environment gemdir – displays the system directory for gems
gem help – basic help directory
gem env – shows the Ruby gem environment
gem list – find gems. You can include letters afterward as wildcards.
gem cleanup – deletes old gem versions
rake -T – Rake helpfile

====================================
====================================
Let’s get started…

INSTALL THESE GEMS (or check if you have them already):
(You may need/want to add “sudo” [no quotes] in front of each of these commands to install)
gem install rubygems-update
gem install thoughtbot-shoulda – Read Me at: http://github.com/thoughtbot/shoulda
gem install rspec-rails
gem install jeweler – Read Me at: http://github.com/technicalpickles/jeweler

============
Establish version control:
DOWNLOAD GIT:

http://git-scm.com/download

CONFIGURE YOUR LOCAL SYSTEM TO TALK TO GITHUB (once you’ve established an account at http://github.com)
git config –global user.name “Real Name”
git config –global user.email “youremail@foo.com
git config –global github.user username

SET UP YOUR PUBLIC KEY (See http://help.github.com/mac-key-setup/ (or your OS) for details)
Check if you have a key: cat ~/.ssh/id_rsa.pub

If you DO have a key:
$ ls
config id_rsa id_rsa.pub known_hosts
$ mkdir key_backup
$ cp id_rsa* key_backup
$ rm id_rsa*

If you DON’T have a key, then create one:
ssh-keygen -t rsa -C “youremail@foo.com

============

CREATE A GEM ON YOUR LOCAL SYSTEM USING JEWELER. (We’re calling our test gem “dabeers.”)
jeweler dabeers –rspec –rdoc –create-repo

#! If there’s a FileUtils problem (this may happen if you’re running Ruby 1.8.6), then:
#! mate /Library/Ruby/Gems/1.8/gems/jeweler-1.4.0/
#! require ‘FileUtils’ in generator.rb (if that’s the error)
#! jeweler dabeers –rspec –rdoc

VERSION YOUR GEM:
rake version:write
#! Since it’s our first rake, the version is set to 0.0.0. If you wanted something different for your initial version, write: rake version BUILD=alpha1 [or change "alpha1" a word or number without quotes]

UPDATE VERSIONS AS YOU UPDATE YOUR GEM:
rake version:bump:major
rake version:bump:minor
rake version:bump:patch

COMMIT TO GITHUB:
rake github:release

COMMIT TO GEMCUTTER:
rake gemcutter:release

Thanks to the NYC Ruby Meetup for the intro to Jeweler and Gemcutter and Peter Harkins for QA of these notes.

Related Posts:

  • No Related Posts
Share: Print Digg del.icio.us Facebook Google Bookmarks StumbleUpon Tumblr Twitter

(PRO)
No Soup for you

Don't be the product, buy the product!

close
YES, I want to SOUP ●UP for ...