mbajur / mina_slack

Slack notifications for Mina

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mina_slack Gem Version

mina_slack is a gem that adds tasks for sending notifications to [Slack] (http://slack.com) using [Mina] (http://nadarei.co/mina).

Installation

gem install mina_slack

Usage example

require 'mina_slack/tasks'
...
# Required mina_slack options
set :slack_api_token, 'xxxyyyzzz'
set :slack_channels, ['#general', '@mbajur', '#nerd']

task :deploy do
  deploy do
    invoke :'slack:notify_deploy_started'
    ...

    to :launch do
      ...
      invoke :'slack:notify_deploy_finished'
    end
  end
end

Available Tasks

  • slack:notify_deploy_started
  • slack:notify_deploy_finished

Available Options

Option Description
slack_api_token API auth token.
slack_channels Array of channels (or users) where notifications will be sent to.
slack_username Name of bot.
default: Deploy
slack_author Author of a deploy displayed in deploy messages.
default: Someone
slack_link_names Find and link channel names and usernames.
default: 1
slack_parse Change how messages are treated. [Read more] (https://api.slack.com/docs/formatting)
default: full
slack_icon_url URL to an image to use as the icon for this message
default: nil
slack_icon_emoji emoji to use as the icon for this message. Overrides slack_icon_url.
default: :slack:

* required options

Todo

  • Write some tests

Copyright

Copyright (c) 2014 Mike Bajur http://github.com/mbajur

See LICENSE for further details.

About

Slack notifications for Mina

License:MIT License


Languages

Language:Ruby 100.0%