Skip to content
keita edited this page Sep 12, 2010 · 10 revisions

Home.ja (日本語)

RTask

RTask provides easy way to release Ruby’s gem packages.

  • You can release gem, tgz, and zip packages by only one step.
  • You can publish API documentation by only one step.
  • Rakefile is not needed if you want.

And this also provides useful Rake tasks for releasing packages and uploading documents.

Install


% sudo gem install rtask

Usage

How to release

First, you should setup rubyforge and Gemify.


# if you haven't used rubyforge
% rubyforge setup
% rubyforge login

# don't forget to get the project information when you create new project
% rubyforge config <project name>

# to create .gemified
% gemify

Now you can release.


% rtask -r

Finished to release, it’s all!

How to publish API documentation


% rtask -p

It’s all.

How to clean

If you finished to release packages and publish API documentation, let’s clean it.


% rtask -c

Rake with RTask

If you want to use RTask with Rakefile, add “RTask.new”.


require "rubygems"
require "rtask"

RTask.new

Now you can see many useful tasks.


% rake -T
rake clean         # Remove any temporary products.
rake clobber       # Remove any generated file.
rake clobber_rdoc  # Remove rdoc products
rake gem           # Create the gem package
rake publish       # Upload API documentation
rake rdoc          # Build the rdoc HTML Files
rake release       # Release new gem version
rake rerdoc        # Force a rebuild of the RDOC files
rake tgz           # Create the tgz package

Do you like these tasks? If you need only packaging tasks, you can do like this.


require "rubygems"
require "rtask"

RTask.new(:use => :packages)


rake gem       # Create the gem package
rake packages  # Create packages
rake tgz       # Create the tgz package
rake zip       # Create the zip package

Links