README

此存储库包含与 deployer 集成的 Chatwork 脚本。

安装

composer require thangcx-1985/deployer-chatwork-notification

将脚本文档包含在 deploy.php 文件中。

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

配置

必需

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 令牌，必需
• chatwork_room_id – Chatwork 房间 ID，必需
• project_link – GitHub 项目链接，格式为 https 协议：https://github.com/user/repository ，必需

消息

• chatwork_text – 通知消息模板，默认

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

• chatwork_success_text – 成功模板，默认

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

• chatwork_failure_text – 失败模板，默认

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

• chatwork_rollback_text – 回滚模板，默认

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

• 自定义

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

任务

• chatwork:notify – 向 Chatwork 发送消息
• chatwork:notify:success – 向 Chatwork 发送成功消息
• chatwork:notify:failed – 向 Chatwork 发送失败消息
• chatwork:notify:rollback – 向 Chatwork 发送回滚消息

用法

如果您只想通知部署开始，请只添加此行

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

如果您想通知部署成功结束，请也添加此行

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

许可

在 MIT 许可证下许可。