hipchat-notify

The hipchat notify step sends a message based on the build or deploy outcome. It supports sending a message for passed and failed builds, and for passed and failed deploys. For the failed builds or deploys to work though, you need to add it to the after-steps section of a build or deploy, to ensure it gets run.

What's new

• Using curl instead of python. (thanks @ReleaseQueue)
  • Using the HipChat v2 Room Notification API.
  • from-name no longer needed. The name comes from the label you give when creating the HipChat room token.

Options

• token (required) Your HipChat token (retrieve yours from https://wercker.hipchat.com/account/api).
• room-id (required) The id of the HipChat room (retrieve yours from https://www.hipchat.com/rooms/ids).
• passed-message (optional) The message which will be shown on a passed build or deploy.
• failed-message (optional) The message which will be shown on a failed build or deploy.
• passed-color (optional, default: green) The color of a passed build/deploy message in HipChat.
• failed-color (optional, default: red) The color of a failed build/deploy message in HipChat.
• passed-notify (optional, default: false) If this is true the passed build/deploy message will make HipChat notify the user.
• failed-notify (optional, default: true) If this is true the passed build/deploy message will make HipChat notify the user.
• on (optional, default: always) When should this step send a message. Possible values: always and failed.
• message-format (optional, default: html) Send the noticiation in html or text message format. html message format support links, but does not support emoticons. text message format supports emoticons, but does not support links.

Tokens

To be able to post notifications you need a V2 OAuth token. You can get these on the settings page of a user. This username will be used when posting notifications.

The previous version (1.x) used to use V1 tokens, these however are deprecated. This is the reason we switched to the new V2 tokens.

Example

Add HIPCHAT_TOKEN as deploy target environment variable or application environment variable.

build:
  after-steps:
    - hipchat-notify:
        token: $HIPCHAT_TOKEN
        room-id: "id"

You may need to add sudo to your box:

  steps:
    - install-packages:
        packages: sudo

License

The MIT License (MIT)

Changelog

2.0.0

• Using curl instead of python. (thanks @ReleaseQueue)
  • Using the HipChat v2 Room Notification API.
  • from-name no longer needed. The name comes from the label you give when creating the HipChat room token.

1.0.5

• Add support for text message format.

1.0.3

• Fix bug if from-name contains a space (thanks @anfedorov)

1.0.2

• Remove emoticons introduced by version 1.0.1.

1.0.1

• Add more icons to the default messages

1.0.0

• Add links to application and build/deploy

0.1.6

• Add support for color for passed and failed messages (thanks adams-sarah)
• Add support for 'notify' for passed and failed messages

0.1.5

Broken

0.1.4

• Fix example in readme
• Update readme