deployer/docs/contrib/rocketchat.md

rocketchat

Source

Installing

Create a RocketChat incoming webhook, through the administration panel.

Require the new recipe into your deploy.php

require 'contrib/rocketchat.php';

Add hook on deploy:

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

Configuration

• rocketchat_webhook - incoming rocketchat webook required

  set('rocketchat_webook', '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 {{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 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

rocketchat_icon_emoji

Source

':robot:'

rocketchat_icon_url

Source

null

rocketchat_channel

Source

null

rocketchat_room_id

Source

null

rocketchat_username

Source

null

rocketchat_webhook

Source

null

rocketchat_color

Source

'#000000'

rocketchat_success_color

Source

'#00c100'

rocketchat_failure_color

Source

'#ff0909'

rocketchat_text

Source

'_{{user}}_ deploying `{{branch}}` to *{{target}}*'

rocketchat_success_text

Source

'Deploy to *{{target}}* successful'

rocketchat_failure_text

Source

'Deploy to *{{target}}* failed'

Tasks

rocketchat:notify

Source

Notify RocketChat.

rocketchat:notify:success

Source

Notifying RocketChat about deploy finish.

rocketchat:notify:failure

Source

Notifying RocketChat about deploy failure.