deployer/docs/contrib/hipchat.md
Anton Medvedev 4bdf95ebda Update docs
2022-09-12 12:29:44 +02:00

1.6 KiB
Raw Blame History

Hipchat Recipe

require 'contrib/hipchat.php';

Source

Configuration

  • hipchat_token Hipchat V1 auth token
  • hipchat_room_id Room ID or name
  • hipchat_message Deploy message, default is _{{user}}_ deploying {{branch}} to *{{target}}*
  • hipchat_from Default to target
  • hipchat_color Message color, default is green
  • hipchat_url The URL to the message endpoint, default is https://api.hipchat.com/v1/rooms/message

Usage

Since you should only notify Hipchat room of a successful deployment, the hipchat:notify task should be executed right at the end.

after('deploy', 'hipchat:notify');

Configuration

hipchat_color

Source

'green'

hipchat_from

Source

'{{target}}'

hipchat_message

Source

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

hipchat_url

Source

'https://api.hipchat.com/v1/rooms/message'

Tasks

hipchat:notify

Source

Notifies Hipchat channel of deployment.