notification resource is used to connect DevOps Assembly Lines to notification providers of your choice. These are providers we currently support:
You can send notifications upon the following events in your workflow:
- Job started (on_start)
- Job completed successfully (on_success)
- Job failed (on_failure)
- Job canceled (on_cancel)
You can create a
notification resource by adding it to
resources: - name: <string> type: notification integration: <string> pointer: <object>
name-- should be an easy to remember text string
type-- is set to
integration-- name of the subscription integration, i.e. the name of your integration at
https://app.shippable.com/subs/[github or bitbucket]/[Subscription name]/integrations. Currently supported providers are:
pointer-- is an object that contains provider specific properties
pointer: method: email recipients: - "firstname.lastname@example.org" - "email@example.com"
pointer: method: irc recipients: - "#beta" - "@botnot"
integration: <slack integration name> pointer: recipients: - "#beta" - "@botnot"
integration: <hipchat integration name> pointer: recipients: - "#beta" - "@botnot"
Used in Jobs
This resource is used as a
NOTIFY for all jobs. For more information, see the jobs overview.
Default Environment Variables
notification is used as an
OUT for a
runCI job, a set of environment variables is automatically made available that you can use in your scripts.
<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. For example,
my-key-1 will be converted to
my_key_1 will be converted to
||The name of the resource.|
||The ID of the resource.|
||The type of the resource. In this case
||Values from the integration that was used. More info on the specific integration page.|
||The operation of the resource; either
||The directory containing files for the resource.|
||Method defined in the pointer. Available if set.|
||Recipients array values 0 to N depending on how many of them are set|
||SourceName defined in the pointer.|
||The ID of the version of the resource being used.|
||The number of the version of the resource being used.|
Shippable Utility Functions
To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.
How to use these utility functions is documented here.