Giter VIP home page Giter VIP logo

deployrjs's Introduction

DeployrJS allows quickly bootstrapping a deployment server that listens to github web hooks and does whatever you want whenever an action occurs. This includes system commands and/or arbitrary JS

Setup

1. Install npm install --save deployrjs or yarn add deployrjs

2. take over the planet

const Deployr = require('deployrjs');
const exec = require('child-process-promise').exec;

/* optional: for slack notifications */
const Slack = require('deployrjs/addons/slack')('https://hooks.slack.com/services/xxxxxx/xxxxxx/xxxxxx'); // Slack webhook URL

const deployment = new Deployr({
    // this is your github secret key.
    // Not passing this will disable verification (less secure)
    key: '#####',

    // port to listen on
    port: 4000,

    // branch to deploy (optional)
    // deploy only when this branch is updated
    branch: 'master',
});

deployment.listen((action, pull) => {
    // "action" is the object sent by github web hook

    pull()
        .then(() => {
            Slack.post('Deploying...');
            
            // At this point, files are identical to git repo
            // Let's re-run a build script
            return exec('npm run build');
        })
        
        .then(() => {
            Slack.post('Deployment successful!');
        })

        .catch(err =>
            Slack.post('Deployment failed!');
        );
});

use Promise wrappers for async functions. e.g. https://www.npmjs.com/package/fs-promise

deployrjs's People

Contributors

dependabot[bot] avatar jakebooher avatar kylerc avatar snyk-bot avatar tushar-singh avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

deployrjs's Issues

Callback code (for Slack for example)

Can we add a callback so that we can choose which channel it will create a message for on success or fail at least of a deploy?

"{$branch} successfully deployed to project."

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.