Notify people on a channel (email or slack) after a deployment. This tool use the deploy result json file.
Works in Unix like system. Windows is not tested.
npm install -g sfdc-notify
- Email template:
$ sn -h
Usage: sn [options]
notify people on every channel after a deployment
Options:
-V, --version output the version number
-c, --channel [channel] channel of notification [slack/email]
-f, --filepath [filepath] path of the deploy result file
-e, --email [email] email or list of email to send to
-uc, --usernameCI [usernameCI] username that will post in slack
-ec, --emailCI [emailCI] sender email
-u, --username [username] email displayed user name
-k, --sendgridKey [sendgridKey] sendgrid api key
-t, --templateId [templateId] sendgrid template id
-d, --details [details] true to display all code coverage in slack
-s, --slackWebhook [slackWebhook] slack webhook URL
-h, --help output usage information
var sn = require('sfdc-notify');
sn({
'channel': 'email',
'filepath': 'path/to/deployResult.json',
'email': ['email@user.com'],
'usernameCI': 'Continuous Integration User',
'emailCI': 'emailci@user.com',
'username': 'Firstname Lastname',
'sendgridKey': 'Sengrid Api Key',
'templateId': 'template id',
'details': false
}, console.log);
- commander - The complete solution for node.js command-line interfaces, inspired by Ruby's commander.
- @sendgrid/mail - This library allows you to quickly and easily use the SendGrid Web API v3 via Node.js.
- slack-node - Slack Node SDK, full support for Webhook and the Slack API, continuously updated.
SemVer is used for versioning.
- Gil Avignon - Initial work - gavignon
This project is licensed under the MIT License - see the <LICENSE.md> file for details