Code Monkey home page Code Monkey logo

capistrano-chatwork's Introduction

Capistrano ChatWork

Capistrano extension for notify to ChatWork

Usage

Add the library to your Gemfile:

group :development do
  gem 'capistrano-chatwork', require: false
end

And load it into your deployment script config/deploy.rb:

require 'capistrano-chatwork'

Add ChatWork configuration:

set :chatwork_api_token, 'YOUR_API_TOKEN'
set :chatwork_room_id, 'YOUR_ROOM_ID'

Configuration

You can modify any of the following Capistrano variables in your deploy.rb config.

Required variables

  • chatwork_api_token - Set ChatWork API Token. Defaults to ENV['CHATWORK_API_TOKEN'].
  • chatwork_room_id - Set ChatWork room id for notify message.

Message variables

  • chatwork_deploy_started_message - Set message when deployment is started. Defaults to "#{user} is deploying #{deployment_name} to #{rails_env}"
  • chatwork_deploy_finished_message - Set message when deployment is finished. Defaults to "#{user} finished deploying #{deployment_name} to #{rails_env}"
  • chatwork_deploy_failed_message - Set message when deployment is failed. Defaults to "#{user} failed deployment of #{deployment_name} to #{rails_env}"

Skip notification

Skip notification when set to false, nil or blank string to message variables

# Skip deploy start notification
set :chatwork_deploy_started_message, false

# Skip deploy finished notification
set :chatwork_deploy_finished_message, nil

# Skip deploy failed notification
set :chatwork_deploy_failed_message, ''

Available methods in message

  • user - Get user name from git config, or environment variables.
  • deployment_name - Get from branch and/or application of Capistrano variables.
  • rails_env - Get from rails_env of Capistrano variables.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Copyright

Copyright (c) 2013 Kazuya Takeshima. See LICENSE for details.

capistrano-chatwork's People

Contributors

osdakira avatar rummelonp avatar sue445 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.