README.md in slackistrano-0.1.9 vs README.md in slackistrano-0.1.10
- old
+ new
@@ -1,10 +1,10 @@
# Slackistrano
[](http://badge.fury.io/rb/slackistrano)
-[](https://codeclimate.com/github/supremegolf/slackistrano)
-[](https://travis-ci.org/supremegolf/slackistrano)
+[](https://codeclimate.com/github/phallstrom/slackistrano)
+[](https://travis-ci.org/phallstrom/slackistrano)
Send notifications to [Slack](https://slack.com) about [Capistrano](http://www.capistranorb.com) deployments.
If you need Capistrano v2 support, check out [capistrano-slack](https://github.com/j-mcnally/capistrano-slack).
@@ -31,30 +31,29 @@
1. Using *Incoming WebHooks* integration, offering more options but requires one of the five free integrations. This is the default option.
2. Using *Slackbot*, which will not use one of the five free integrations. Enable via the `:slack_via_slackbot` option.
In both case, you need to enable the integration inside Slack and get the token and/or webhook url that will be needed later.
-
-
Require the library in your application's Capfile:
require 'slackistrano'
If you post using *Incoming Webhooks* you need to set your webhook url in your application's config/deploy.rb:
set :slack_webhook, "https://hooks.slack.com/services/XXX/XXX/XXX"
-If you choose to post using *Slackbot* you **must** set your team and and token in your application's config/deploy.rb:
+If you choose to post using *Slackbot* you **must** set your team, token, and channel in your application's config/deploy.rb:
set :slack_via_slackbot, true
- set :slack_team, "supremegolf"
+ set :slack_team, "teamname"
set :slack_token, "xxxxxxxxxxxxxxxxxxxxxxxx"
+ set :slack_channel, '#general'
Optionally, override the other slack settings:
set :slack_icon_url, -> { 'http://gravatar.com/avatar/885e1c523b7975c4003de162d8ee8fee?r=g&s=40' }
set :slack_icon_emoji, -> { nil } # will override icon_url, Must be a string (ex: ':shipit:')
- set :slack_channel, -> { '#general' }
+ set :slack_channel, -> { nil } # Channel to post to. Optional. Defaults to WebHook setting. Required if using Slackbot.
set :slack_channel_starting, -> { nil } # Channel to post to. Optional. Defaults to :slack_channel.
set :slack_channel_finished, -> { nil } # Channel to post to. Optional. Defaults to :slack_channel.
set :slack_channel_failed, -> { nil } # Channel to post to. Optional. Defaults to :slack_channel.
set :slack_username, -> { 'Slackistrano' }
set :slack_run_starting, -> { true }