echoe Rubygems

A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment

3 years after


A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.

== License

Copyright 2007-2011 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.

== Features

  • simple configuration
  • comprehensive gem deployment
  • cross-packaging
  • signed gem support
  • automatic changeset parsing
  • documentation upload to any host

= Usage

== Installation

Install the gem: sudo gem install echoe

If you haven't already, make sure is configured locally and your password is correctly set.

== Project configuration

Organize your gem according to the usual structure:


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''gem_name')

More advanced configuration is described in the Echoe class.

== Deploying your gem

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.

= Extras

== All Rake tasks

The following tasks are made available to your gem.


  • manifest - Build a manifest list. Shows added and removed files.
  • docs - Build the documentation.
  • package - Build all the packages.


  • test - Run the test suite.
  • coverage - Generate a coverage report.
  • compile - Compile C extensions, if available.
  • clean - Clean up generated documentation, packaging, and build files.
  • install - Install the gem locally.
  • uninstall - Uninstall the gem.


  • publish_docs - Publish documentation to the web.
  • release - Package and upload the latest release to

== Reporting problems

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.

Related Repositories



A net-ssh extension library that provides an API for programmatically interactin ...



Noe is a simple, general-purpose and extensible skeleton generator from project ...



‹ᴜɴᴍᴀɪɴᴛᴀɪɴᴇᴅ› A Ruby module for accessing the ncurses library ...



Git utilities for multiple repositories & submodules ...



RedCloth is a Ruby library for converting Textile into HTML. This fork is the cu ...

Top Contributors

evan ELLIOTTCABLE technicalpickles bmaland ndarilek rsanheim andys Flameeyes greatseth caius anatol janfri mdesantis michaelklishin TylerRick


-   echoe-4.6.6 zip tar
-   echoe-4.6.5 zip tar
-   echoe-4.6.3 zip tar
-   echoe-4.6.1 zip tar
-   echoe-4.6.0 zip tar
-   echoe-4.5.6 zip tar
-   echoe-4.5.5 zip tar
-   echoe-4.5.4 zip tar