Giter Club home page Giter Club logo

auto-stage's Introduction

auto-stage

Automatically run your latest code after pushing to GitHub

What does it do?

auto-stage will run a web server that will listen for GitHub web hooks.
In particular, it will look for a push to a branch of your choosing.
Once it sees a push, it will automatically:

  1. git pull {remote} {branch}
  2. npm install
  3. stop the previous process
  4. npm start

Installation and Configuration

You will need to setup a GitHub Webhook.
Go to your repo's Settings -> Webhooks and services

Ensure:

  • the Content type is application/json
  • the Payload URL is correct.
  • Note: if you do not choose a port, the default port is 3000
  • the web server will be publicly accessible
  • the projectPath (see below) is a git repository and has git pull access to the remote code

Use it as a node_module:

npm install auto-stage --save

Usage

The module exports a single function which takes two parameters:

  • projectPath: a relative or absolute path to your project from your working directory.
  • options: A hash which accepts three optional values:
  • port: The desired port of the web server
  • remote: The git remote to use for use in git pull
  • branch: The remote branch for use in git pull
const stage = require('auto-stage');
var options = {
    port: 8080,
    remote: 'origin',
    branch: 'staging'
};

stage('/projects/my-app', options); 

Options

TODO

  • Use as a command line tool
  • Use the secret as provided in the Webhooks configuration

License

MIT

auto-stage's People

Contributors

seikho avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

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.