deployer/docs/contrib/hangouts.md
Anton Medvedev 47a193f9af
Add docgen
2020-10-02 01:11:13 +03:00

2.1 KiB
Raw Blame History

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('success', 'chat:notify:success');

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

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

Config

chat_title

Source

Title of project

chat_subtitle

Source

favicon

Source

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

chat_line1

Source

Deploy messages

chat_line2

Source

Tasks

chat:notify

Source

chat:notify:success

Source

chat:notify:failure

Source