Rocketchat Recipe
require 'contrib/rocketchat.php';
Installing
Create a RocketChat incoming webhook, through the administration panel.
Add hook on deploy:
before('deploy', 'rocketchat:notify');
Configuration
rocketchat_webhook
- incoming rocketchat webook requiredset('rocketchat_webhook', 'https://rocketchat.yourcompany.com/hooks/XXXXX');
rocketchat_title
- the title of the application, defaults to{{application}}
rocketchat_text
- notification messageset('rocketchat_text', '_{{user}}_ deploying {{branch}} to {{target}}');
rocketchat_success_text
– success template, default:set('rocketchat_success_text', 'Deploy to *{{target}}* successful');
rocketchat_failure_text
– failure template, default:set('rocketchat_failure_text', 'Deploy to *{{target}}* failed');
rocketchat_color
– color's attachmentrocketchat_success_color
– success color's attachmentrocketchat_failure_color
– failure color's attachment
Usage
If you want to notify only about beginning of deployment add this line only:
before('deploy', 'rocketchat:notify');
If you want to notify about successful end of deployment add this too:
after('deploy:success', 'rocketchat:notify:success');
If you want to notify about failed deployment add this too:
after('deploy:failed', 'rocketchat:notify:failure');
Configuration
rockchat_title
return get('application', 'Project');
rocketchat_icon_emoji
':robot:'
rocketchat_icon_url
null
rocketchat_channel
null
rocketchat_room_id
null
rocketchat_username
null
rocketchat_webhook
null
rocketchat_color
'#000000'
rocketchat_success_color
'#00c100'
rocketchat_failure_color
'#ff0909'
rocketchat_text
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
rocketchat_success_text
'Deploy to *{{target}}* successful'
rocketchat_failure_text
'Deploy to *{{target}}* failed'
Tasks
rocketchat:notify
Notifies RocketChat.
rocketchat:notify:success
Notifies RocketChat about deploy finish.
rocketchat:notify:failure
Notifies RocketChat about deploy failure.