Base class for defining the behavior between screwdriver and notifications plugins
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.editorconfig
.eslintignore
.eslintrc.yaml
.gitignore
.npmignore
CONTRIBUTING.md
LICENSE
README.md
index.js
package.json
screwdriver.yaml

README.md

Notifications Base

Version Downloads Build Status Open Issues Dependency Status License

Base class for defining the behavior between screwdriver and notifications plugins

Usage

npm install screwdriver-notifications-base

Interface

This is a 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.