Sending CI notifications to IRC
You can send IRC notifications for various events in your CI workflow, including when builds start or finish.
The basic configuration looks like this:
integrations: notifications: - integrationName: irc type: irc recipients: - "chat.freenode.net#channel1" - "chat.freenode.net#channel2"
Use the descriptions of each field below to modify the
yml and tailor it to your requirements.
integrationNamevalue is always
ircsince no account or subscription integration is required.
recipientsis an array that specifies the channels you want to send the notification to. If there is just a single recipient, use the format
And you're done. You will receive IRC notifications for all branches when builds fail, or change from failed to passed, or pull requests are built. To change some of these default configs, please see the advanced config section below.
1. Limiting branches
By default, IRC notifications are sent for builds for all branches. If you want to only send notifications for specific branches, you can do so with the
integrations: hub: - integrationName: irc type: irc recipients: - "chat.freenode.net#channel1" - "chat.freenode.net#channel2" branches: only: - master
branches allows you to choose the branches for which you want to send notifications. The
only tag should be used when you only want to send notifications for builds of specific branches. You can also use the
except tag to exclude specific branches. Wildcards are also supported.
2. Customizing notification triggers
By default, IRC notifications are sent for the following events:
- A build fails
- Build status for a project changes from failed to passed
- A pull request is built
You can further customize these defaults with the following config:
integrations: hub: - integrationName: irc type: irc recipients: - "chat.freenode.net#channel1" - "chat.freenode.net#channel2" on_success: always | change | never on_failure: always | change | never on_cancel: always | change | never on_start: always | never on_pull_request: always | never
You can set the following options for the
alwaysmeans that you will always receive a notification for that event.
nevermeans that you will never receive a notification for that event.
on_cancelfields means you will receive notifications only when the build status changes to success, failure or canceled respectively. This value isn't supported for
If you do not specify any of these tags, the defaults are:
on_success is set to
on_failure is set to
on_cancel is set to
on_start is set to
on_pull_request is set to
Removing IRC notifications
To stop sending IRC notifications, simply remove the configuration from the
shippable.yml for that project.
Improve this page
We really appreciate your help in improving our documentation. If you find any problems with this page, please do not hesitate to reach out at firstname.lastname@example.org or open a support issue. You can also send us a pull request to the docs repository.