README.rdoc in pboling-capistrano_mailer-3.0.2 vs README.rdoc in pboling-capistrano_mailer-3.1.0
- old
+ new
@@ -1,20 +1,18 @@
-= Capistrano Mailer v3.0.1 (20090921)
+= Capistrano Mailer v3.1.0 (20090917)
* For Capistrano Deployment Email Notification
- * It is a Capistrano Plugin / Rails Plugin / Ruby Gem
+ * It is a Capistrano Plugin / Ruby Gem that requires ActionMailer
Ever wanted to be emailed whenever someone on the team does a cap deploy of trunk or some tag to some server.
Wouldn't it be nice to know about it every time a release was deployed? For large rails projects this type of coordination is essential,
and this plugin makes sure everyone on the need to know list is notified when something new is deployed.
This plugin/gem is an extension to Capistrano.
That means it registers itself with Capistrano as a plugin and is therefore available to call in your recipes.
-It is compatible with, but does not require, the deprec gem.
-
If you are looking to roll your own email integration into capistrano then try this pastie:
http://pastie.org/146264 (thanks to Mislav Marohnić).
But if you want to take the easy road to riches then keep reading ;)
-- figurative "riches" of course, I promise nothing in return for your using this plugin
@@ -30,21 +28,25 @@
* at least Rails 1.2.6 (might work with older versions, but has not been tested)
* at least Capistrano 2.4.3 (might work with capistrano as old as 2.1.0, but has not been tested)
+ * Known to be compatible with SCMs as of version 3.1.0: Perforce, SVN
+ * Known to be compatible with, but does not require, the deprec gem.
+
+
== Installation
Gem Using Git building from source:
mkdir -p ~/src
cd ~/src
git clone git://github.com/pboling/capistrano_mailer.git
cd capistrano_mailer
gem build capistrano_mailer.gemspec
- sudo gem install capistrano_mailer-3.0.1.gem # (Or whatever version gets built)
+ sudo gem install capistrano_mailer-3.0.3.gem # (Or whatever version gets built)
Then cd to your rails app to optionally freeze the gem into your app:
rake gems:freeze GEM=capistrano_mailer
# You do NOT need to add a config.gem line to environment.rb for capistrano mailer.
@@ -62,19 +64,18 @@
Using SVN (deprecated, repository is no longer updated):
./script/plugin install http://capistrano-mailer.googlecode.com/svn/trunk/capistrano_mailer
-
== Upgrading
-From version 2.1.0 to version 3.0.1:
+From version 2.1.0 to version 3.x.x:
-Update the way CapistranoMailer is configured using the new method: CapMailer.configure_capistrano_mailer, see below.
-Update the require statement at the top of deploy.rb, see below (note for plugin change from capostrano_mailer to capistrano/mailer).
+1. Update the way CapistranoMailer is configured using the new method: CapMailer.configure_capistrano_mailer, see below.
+2. Update the require statement at the top of deploy.rb, see below (note for plugin change from capostrano_mailer to capistrano/mailer).
+3. Change the mailer.send to mailer.send_notification_email in your cap recipe.
-
== Usage
1. Install as gem or plugin.
2. Add this line to the top of your deploy.rb:
@@ -210,10 +211,11 @@
Take a look at the templates that comes with the plugin to see how it is done (views/cap_mailer/...)
----------------------------------------------------------------------------------
- This plugin is a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com)
+ This plugin is a collaboration between Sagebit, LLC (http://www.sagebit.com) and Peter Boling (http://www.peterboling.com).
+ Written initially while Peter Boling was working at Sagebit for use in various projects.
Author: Peter Boling, peter.boling at gmail dot com
Copyright (c) 2009 Peter Boling of 9thBit LLC, released under the MIT license
Copyright (c) 2007-8 Sagebit LLC, released under the MIT license