@@ -10,6 +10,8 @@ Setup and configuration are done entirely inside your deploy.rb file to keep it This even includes the Net::SMTP TLS hack inside as a vendored dependancy to allow super easy email sending without setting up an MTA. +This was extended a bit to support inclusion a list of Git commits that were deployed to the server in the email. Read CONFIG section for more information. + == CONFIG In your Capistrano config file (usually deploy.rb): @@ -29,9 +31,15 @@ In your Capistrano config file (usually deploy.rb): # define the options for the actual emails that go out -- :recipients is the only required option set :cap_gun_email_envelope, { :recipients => %w[joe@example.com, jane@example.com] } - # register email as a callback after restart - after "deploy:restart", "cap_gun:email" + # add these settings if you use Git and want to display a list of changes that were deployed to the server + set :cap_gun_include_pending_changes, true + # if you don't have this setting, we will just put hash instead of URL to github + set :cap_gun_view_git_commit_url, "https://github.com/wildbit/beanstalk/commit/%s" + + # people who have capistrano settings with tasks should tweak this. + set :cap_gun_pending_cmd, "cap #{ARGV.first} deploy:pending" + # Test everything out by running "cap cap_gun:email" == USAGE README.rdoc @@ -125,6 +125,11 @@ module CapGun Comment: #{capistrano[:comment] || "[none given]"} +#{ + unless capistrano[:pending_changes].blank? + "\nDeployed changes\n================\n" + capistrano[:pending_changes].to_s + end +} Nerd details ============ Release: #{capistrano[:current_release]} @@ -147,13 +152,45 @@ if Object.const_defined?("Capistrano") Capistrano::Configuration.instance(:must_exist).load do + before "deploy:update_code", "cap_gun:gather_pending_changes" + after "deploy:restart", "cap_gun:email" + namespace :cap_gun do desc "Send notification of the current release and the previous release via email." task :email do CapGun::Helper.load_mailer_config(self) CapGun::Mailer.deliver_deployment_notification(self) end + + def shorten_string(msg, limit=100) + msg = msg.to_s + if msg.size < limit + msg + else + msg.to_s[0,limit-1] + "..." + end + end + + def view_git_commit_url(hash) + if self[:cap_gun_view_git_commit_url] + self[:cap_gun_view_git_commit_url] % hash + else + hash + end + end + + desc "Gather information about pending changes (should be ran before the deployment completed)" + task :gather_pending_changes do + next unless self[:cap_gun_include_pending_changes] + changes = String.new + raw = `#{self[:cap_gun_pending_cmd] || "cap deploy:pending"}` + raw.scan(/commit (\w{40}).+?Author: (.+?) <.+?>\nDate: .+?\n\s+(.+?)\n/m).each { |(hash, author, message)| + next if message =~ /Merge branch/ + changes << "* #{shorten_string(message)}\n#{view_git_commit_url(hash)} [#{author}]\n\n" + } + set(:pending_changes, changes) + end end end -end \ No newline at end of file +end lib/cap_gun.rb 000566ce5713d6b0ad88b1ff83f24b35444db0d8 Dima Sabanin sdmitry@gmail.com http://github.com/railsmonk/cap_gun/commit/2a52aefffcf6c362df99823762b09c262b15fffd 2a52aefffcf6c362df99823762b09c262b15fffd 2009-03-18T10:57:38-07:00 2009-03-18T10:57:38-07:00 Add information about Git commits that were deployed on server into deployment notification email. 08e354e2d71a86162391f3210cac39b1c842cc58 Dima Sabanin sdmitry@gmail.com