Releasing Talia

This guide explains how to build the gem for the talia_core, and how to build and release the "public" documentation. The gem will be released to Gemcutter/Rubygems.org, and the documentation will end up as pages on GitHub. The procedures will usually be very similar for all projects that have gems and/or documentation. The documentation will always be at http://net7.github.org/<name_of_project>

Building the documentation

The RDoc documentation can be built using a rake task. For talia_core the task is called rdoc, other names could be doc or html. This rake task will create a local version of the documentation, but not upload it to github.

To upload the documentation, we will use Gokdok, which will automatically build and push the documentation to github. Check out the gokdok link to find out what it does, and how the Github pages work in detail. To get up and running, just do

# Install it
gem install gokdok
# On the first use for each project
rake gokdok:init 
# Each time you publish the documentation
rake gokdok:push

Building the gem

The gem building process is pretty much automated thanks to Jeweler. So, before you can release a new gem, install it:

gem install jeweler

To build the gem, you should first commit all your changes to git. When you think you're ready to release, run the unit tests. Fix the bugs. Then, when the unit tests pass, you may be ready to release. Now update the version of the gem:

# This will update the "patch" version,
# e.g. going from 0.0.1 to 0.0.2
rake version:bump:patch
# Alternative: bump to 0.1.0
# rake version:bump:minor
# Alternative: bump to 1.0.0
# rake version:bump:major

After that, just create and upload the gem with the help of jeweler:

rake release

If you get no error messages, the new gem version should now show on rubygems.org