Skip to main content
Version: 7.x

hipchat

Source

Installing#

Add to your deploy.php

require 'contrib/hipchat.php';

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

Default value
'green'

hipchat_from#

Source

Default value
'{{target}}'

hipchat_message#

Source

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

hipchat_url#

Source

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

Tasks#

hipchat:notify#

Source

Notifying Hipchat channel of deployment.