Send Flowdock notification on successful deployment
Simple utility for sending a notification to Flowdock on a successful deployment. This project uses the Flowdock push API.
npm install flowdock-deploy-notify
Passing options via command line
flowdock-deploy-notify \\--flowToken=df89s7af89ds0a7daa \\--fromEmailemail@example.com=http://dev.foo.com/bar--verbose
Passing options via configuration object
moduleexports =flowToken: 'df89s7af89ds0a7das'fromEmail: 'firstname.lastname@example.org'url: ''
Then simply run
The tool looks by default for a configuration object from
./flowdock-deploy-notify.config.js. You can also specify an alternative path for the configuration object with the
var flowdockDeployNotify = ;;
flowToken: Flowdock token for the flow to which we wish to send the notification
fromEmail: From email address required by Flowdock.
url: URL to which the project was deployed, to be included in the message.
project: Name of the project, to be included in the message. Defaults to one determined by project-name.
branch: Branch name to include in the message. Defaults to one determined by git-rev-sync if there is a git repository.
env: Name of target environment to include in message. Defaults to
source: Source name required by Flowdock. Defaults to
Only available via command line
config: Alternative path for configuration object.
verbose: Enable verbose output for command line.
Make sure you have the right node version
As the tests are sending actual notifications to the Flowdock API, you will need have a
FLOW_TOKEN environment variable defined for tests to work.
FLOW_TOKEN=your_test_flow_token npm test