screwdriver-notifications-base

Notifications Base

Base class for defining the behavior between screwdriver and notifications plugins

Usage

npm install screwdriver-notifications-base

Interface

This is an interface for receiving Screwdriver API events and sending notification to users based on their job settings.

notify

Expected Outcome

Notify the user based on their job settings, e.g. email, slack.

Extending

To extend the base class, the functions to override are:

1. _notify
2. events (optional)

Override events if you want to send notification based on other events.

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.