@johnwatkins0/node-autodeploy v1.0.25

node-autodeploy

Associate branches of a Git project with remote servers. Auto-sync your repository to the remote server over SSH. Useful for developers working with servers they have minimal control over.

Installation

Install the package in your project:

npm install --save-dev @johnwatkins0/node-autodeploy

.deploy-servers.js

Create a server config file, .deploy-servers.js in the project root. It should export a settings object like the example below:

module.exports = {
  master: {
    active: false,
    server: 'server-hostname',
    destPath: '/path/on/the/server/',
    username: 'username',
    srcPath: `${__dirname}/`
  },
  staging: {
    active: true,
    server: 'server-hostname',
    destPath: '/path/on/the/server/',
    username: 'username',
    srcPath: `${__dirname}/`
    port: 22
  }
};

Each object key should be identical to the name of the Git branch you want to associate with the server. In the example above, the staging deployment will run if the current Git branch is staging.

Settings

.deploy-settings.js

Create a settings config file, .deploy-settings.js in the project root. This provides another JavaSript settings object to determine the behavior of the rsync command run by the script.

Example:

module.exports = {
  exclude: [
    '.deploy*',
    '*.json',
    'src',
    '.git*',
    'package.json',
    'tests',
    '.eslintrc',
    'node_modules/'
  ],
};

Deploying

With the two settings files in place, execute the following in the project's root:

node node_modules/node-autodeploy

Or use the provided binary:

node node_modules/.bin/autodeploy

Or use an NPM script:

{
  "scripts": {
    "deploy": "autodeploy"
  }
}