Send notifications to Slack about Capistrano deployments.
If you need Capistrano v2 support, check out capistrano-slack.
- Capistrano >= 3
- Ruby >= 2.0
- A Slack account
Add this line to your application's Gemfile:
gem 'slackistrano', require: false
And then execute:
$ bundle
Set up an "Incoming WebHooks" integration in Slack. Make a note of the token as you'll need it later.
Require the library in your application's Capfile:
require 'slackistrano'
Set your team and token in your application's config/deploy.rb:
set :slack_team, "supremegolf"
set :slack_token, "xxxxxxxxxxxxxxxxxxxxxxxx"
Optionally, override the other slack settings:
set :slack_icon_url, ->{ 'http://gravatar.com/avatar/885e1c523b7975c4003de162d8ee8fee?r=g&s=40' }
set :slack_channel, ->{ '#general' }
set :slack_username, ->{ 'Slackistrano' }
set :slack_run_starting, ->{ true }
set :slack_run_finished, ->{ true }
set :slack_msg_starting, ->{ "#{ENV['USER'] || ENV['USERNAME']} has started deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :rails_env, 'production'}." }
set :slack_msg_finished, ->{ "#{ENV['USER'] || ENV['USERNAME']} has finished deploying branch #{fetch :branch} of #{fetch :application} to #{fetch :rails_env, 'production'}." }
Note: You may wish to disable one of the notifications if another service (ex: Honeybadger) also displays a deploy notification.
Test your setup by running:
$ cap production slack:deploy:starting
$ cap production slack:deploy:finished
Deploy your application like normal and you should see messages in the channel you specified.
- Add tests.
- Notify about incorrect configuration settings.
- Notify about unsuccessfull HTTP POSTs.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request