Path: | README |
Last Update: | Fri Jul 03 23:52:03 -0600 2009 |
A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.
Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Ryan Davis/Zen Spider Software and used with permission. See the included MIT-LICENSE file.
The public certificate for the gem is here.
If you use this software, please make a donation, or recommend Evan at Working with Rails.
Install the gem:
sudo gem install echoe
If you haven‘t already, make sure Rubyforge is configured locally and your password is correctly set:
rubyforge setup rubyforge config
Organize your gem according to the usual structure:
lib/ README LICENSE CHANGELOG Rakefile
You can add the bin/ or ext/ folders if you have executables or extensions, respectively.
Your CHANGELOG should be formatted as follows (including newlines):
v2.1. newest change v2. older change v1.9. oldest change
This way Echoe can parse the latest version and changeset message automatically.
Your Rakefile needs the following minimal contents:
require 'echoe' Echoe.new('gem_name')
More advanced configuration is described in the Echoe class.
To deploy the gem and documentation:
rake manifest rake release rake publish_docs
Once you‘ve built your manifest, you only need to rebuild it if you add or remove files from the package structure.
The following tasks are made available to your gem.
Packaging:
Testing:
Upload:
Cleaning:
The support forum is here.
Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.