No commit activity in last 3 years
No release in over 3 years
post to ChatWork before and after the specified task
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

>= 3.0.0
cha
>= 1.2.0
 Project Readme

Capistrano::AroundChatwork

Gem Version Code Climate

post to ChatWork before and after the specified task

example

Installation

Add this line to your application's Gemfile:

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

Usage

Capfile

require "capistrano/around_chatwork"

config/deploy.rb

set :chatwork_api_token, "YOUR_API_TOKEN"
set :chatwork_room_id,   00000000

around_chatwork "deploy"

Customize

If you want to customize messages, set starting_message, ending_message and failure_message

Example

set :starting_message, -> {
  "[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]started[/info]"
}

set :ending_message, -> {
  "[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]done (:elapsed_time: sec)[/info]"
}

set :failure_message, -> {
  <<-MSG
[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]failed (:elapsed_time: sec)
:error_inspect:
:error_backtrace:[/info]
  MSG
}

When these are falsy (e.g. nil or false) or empty string (e.g. ""), notification is skipped.

e.g.

set :starting_message, nil
set :ending_message, ""

Variables

  • :task_name: is replaced to current task name (e.g. deploy)
  • :elapsed_time: is replaced to elapsed time of task (e.g. 1.234)
  • :error_message: is replaced to error message (i.e. Exception#message) if task is failed
  • :error_inspect: is replaced to error inspected message (i.e. Exception#inspect) if task is failed
  • :error_backtrace: is replaced to error backtrace (i.e. Exception#backtrace) if task is failed

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/sue445/capistrano-around_chatwork/fork )
  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 a new Pull Request