thangcx-1985/deployer-chatwork-notification

Deployer's Chatwork Notification

v1.2.2 2021-04-06 03:19 UTC

Replaces

• deployer/recipes: v1.2.2

MIT

• Chu Xuan Thang

• notification
• deployer
• chatwork

README

This repository contains chatwork recipes to integrate with deployer.

Installing

composer require thangcx-1985/deployer-chatwork-notification

Include recipes in deploy.php file.

require 'vendor/thangcx-1985/deployer-chatwork-notification/recipe/chatwork.php';

Configuration

Required

set('chatwork_api_token', YOUR_CHATWORK_API_TOKEN);
set('chatwork_room_id', YOUR_CHATWORK_ROOM_ID);
set('project_link', YOUR_PROJECT_LINK);

• chatwork_api_token – chatwork api token, required
• chatwork_room_id – chatwork room ID, required
• project_link – github project link as https protocol: https://github.com/user/repository , required

Message

• chatwork_text – notification message template, default:

  [info][title]Deployer on {{target}}[/title]{{user}} is deploying branch {{branch}} to {{target}} envirement[/info]
  

• chatwork_success_text – success template, default:

  [info][title]Deployer on {{target}}[/title]Deployment is successful {{pull-request}}[/info]
  

• chatwork_failure_text – failure template, default:

  [info][title]Deployer on {{target}}[/title]Deployment is failed[/info]
  

• chatwork_rollback_text – rollback template, default:

  [info][title]Deployer on {{target}}[/title]Deployment is rolling back[/info]
  

• Custom:

  set('chatwork_text|chatwork_success_text|chatwork_failure_text|chatwork_rollback_text', YOUR_CUSTOME_MESSAGE);
  

Tasks

• chatwork:notify – send message to chatwork
• chatwork:notify:success – send success message to chatwork
• chatwork:notify:failed – send failed message to chatwork
• chatwork:notify:rollback – send rolling back message to chatwork

Usage

If you want to notify only about beginning of deployment add this line only:

before('deploy', 'chatwork:notify');

If you want to notify about successful end of deployment add this too:

after('success', 'chatwork:notify:success');

License

Licensed under the MIT license.