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. Currently supported providers are:
pointer-- is an object that contains provider specific properties
pointer: method: email recipients: - "email@example.com" - "firstname.lastname@example.org"
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 job that can execute user defined scripts, a set of environment variables are configured by the platform that may be useful to set the context before user defined scripts execute as part of the job. These variables are available when this resource is used.
<NAME> is the the friendly name of the resource.
||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.