Name: github-deploy-notify
Owner: Lucify
Description: Simple utility for sending a notification of a deployment to GitHub Deployment API.
Created: 2016-06-16 11:18:07.0
Updated: 2016-07-20 10:29:28.0
Pushed: 2016-06-16 13:34:00.0
Size: 10
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Simple utility for sending a notification to GitHub deployment API of a deployment.
install github-deploy-notify -g
Create file github-deploy-notify.config.js
le.exports = {
thubToken: 'df89s7af89ds0a7daa',
oject: 'my-project-name',
g: 'my-org-name',
dy: {
// insert options according to
// https://developer.github.com/v3/repos/deployments/#create-a-deployment
Then run
ub-deploy-notify --verbose
The tool looks by default for a configuration object from ./github-deploy-notify.config.js
. You can also specify an alternative path for the configuration object with the --config
option.
githubDeployNotify = require('github-deploy-notify');
oyNotify({
thubToken: 'df89s7af89ds0a7daa',
oject: 'my-project-name',
g: 'my-org-name',
dy: {
// insert options according to
// https://developer.github.com/v3/repos/deployments/#create-a-deployment
unction(err) {
if (err) {
console.log('Failed to send notification to GitHub deployment API');
} else {
console.log('Notification delivered to GitHub deployment API');
}
githubToken
: GitHub token.user
: Github user.org
: Github organisation name.project
: Github project name.body
: Parameters according to https://developer.github.com/v3/repos/deployments/#create-a-deployment.skip
: Skip sending the notification.config
: Alternative path for configuration object.verbose
: Enable verbose output for command line.Make sure you have the right node version
use
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.
UB_TOKEN=your_test_flow_token npm test