serverless-notify-after-command

serverless-notify-after-command

This is a simple plugin for Serverless Framework to send a notification to the linux system notification system after any serverless command (successfull or failed).

This plugin depends that your operational system is able to run the bash commands:

sleep 

notify-send

paplay

For the plugin to work, it creates a child process the checks the amount of processes from serverless running in the system.

Install

$ npm install serverless-notify-after-command --save-dev

Add the plugin to your serverless.yml file:

plugins:
  - serverless-notify-after-command

Configure

The configuration of the plugin is done by defining a custom: notifyAfterCommand object in your serverless.yml with your specific configuration.

Attribute	Type	Default	Description
active	Boolean	true	Should run or not by default
blacklist	Array	[]	Blacklist commands, even when active is true
whitelist	Array	[]	Whitelist commands, even when active is false
stages	Array	['development']	The list of stages to run
sound	Boolean	true	True if a sound should be played too

For the stages, important to note how the plugin infers the stage. It gets the --stage option, then serverless.yml custom.stage, then serverless.yml provider.stage then 'development.' The first one it finds, is the value it considers.

custom:
  notifyAfterCommand:
    active: true
    blacklist: []
    whitelist: []
    stages: ['development']
    sound: true

Besides the serverless.yml configuration, you can pass Environment Variables to force it to use or not. Just set the SLS_NOTIFY to true or false, if you want notifications or not.

If you want to force the sound to play event when sound is false, pass the SLS_NOTIFY_SOUND=true.

SLS_NOTIFY=true serverless [command]
SLS_NOTIFY=true sls [command]
SLS_NOTIFY_SOUND=true sls [command]

Roadmap

Customize the notification sound.