Skip to main content
Version: 7.x

hangouts

Source

Require the Google Hangouts Chat recipe in your deploy.php file:

require 'contrib/chat.php';

Add hook on deploy:

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

Configuration

  • chat_webhook – chat incoming webhook url, required
  • chat_title – the title of your notification card, default {{application}}
  • chat_subtitle – the subtitle of your card, default {{hostname}}
  • chat_favicon – an image for the header of your card, default http://{{hostname}}/favicon.png
  • chat_line1 – first line of the text in your card, default: {{branch}}
  • chat_line2 – second line of the text in your card, default: {{stage}}

Usage

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

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

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

after('deploy:success', 'chat:notify:success');

If you want to notify about failed deployment add this too:

after('deploy:failed', 'chat:notify:failure');

Configuration

chat_title

Source

Title of project

chat_subtitle

Source

Default value
get('hostname')

favicon

Source

If 'favicon' is set Google Hangouts Chat will decorate your card with an image.

Default value
'http://{{hostname}}/favicon.png'

chat_line1

Source

Deploy messages

Default value
'{{branch}}'

chat_line2

Source

Default value
'{{stage}}'

Tasks

chat:notify

Source

Notifies Google Hangouts Chat.

chat:notify:success

Source

Notifies Google Hangouts Chat about deploy finish.

chat:notify:failure

Source

Notifies Google Hangouts Chat about deploy failure.



Support Deployer ❤️

Hello, my name is Anton Medvedev (@antonmedv). I'm the creator of the Deployer.
I maintain this open source project in my spare time.
Supporters on GitHub give me extra motivation to work on the project.