Skip to main content
Version: 8.x

Rocketchat Recipe

require 'contrib/rocketchat.php';

Source

Installing​

Create a RocketChat incoming webhook, through the administration panel. Add hook on deploy:

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

Configuration​

  • rocketchat_webhook - incoming rocketchat webook required 
    set('rocketchat_webhook', 'https://rocketchat.yourcompany.com/hooks/XXXXX');
  • rocketchat_title - the title of the application, defaults to {{application}}
  • rocketchat_text - notification message 
    set('rocketchat_text', '_{{user}}_ deploying {{what}} to {{where}}');
  • rocketchat_success_text – success template, default:
set('rocketchat_success_text', 'Deploy to *{{where}}* successful');
  • rocketchat_failure_text – failure template, default:
set('rocketchat_failure_text', 'Deploy to *{{where}}* failed');
  • rocketchat_color – color's attachment
  • rocketchat_success_color – success color's attachment
  • rocketchat_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​

Source

Default value
return get('application', 'Project');

rocketchat_icon_emoji​

Source

Default value
':robot:'

rocketchat_icon_url​

Source

Default value
null

rocketchat_channel​

Source

Default value
null

rocketchat_room_id​

Source

Default value
null

rocketchat_username​

Source

Default value
null

rocketchat_webhook​

Source

Default value
null

rocketchat_color​

Source

Default value
'#000000'

rocketchat_success_color​

Source

Default value
'#00c100'

rocketchat_failure_color​

Source

Default value
'#ff0909'

rocketchat_text​

Source

Default value
'_{{user}}_ deploying `{{what}}` to *{{where}}*'

rocketchat_success_text​

Source

Default value
'Deploy to *{{where}}* successful'

rocketchat_failure_text​

Source

Default value
'Deploy to *{{where}}* failed'

Tasks​

rocketchat:notify​

Source

Notifies RocketChat.

rocketchat:notify:success​

Source

Notifies RocketChat about deploy finish.

rocketchat:notify:failure​

Source

Notifies RocketChat about deploy failure.