Deploy system for PM2

This is the module that allows to do pm2 deploy. Documentation: http://pm2.keymetrics.io/docs/usage/deployment/

Instalation

$ npm install pm2-deploy

Programmatic Usage

1var deployForEnv = require('pm2-deploy').deployForEnv;
2
3// Define deploy configuration with target environments
4var deployConfig = {
5  prod: {
6    user: 'node',
7    host: '212.83.163.168',
8    ref: 'origin/master',
9    repo: 'git@github.com:Unitech/eip-vitrine.git',
10    path: '/var/www/test-deploy'
11  },
12  dev: {
13    user: 'node',
14    host: '212.83.163.168',
15    ref: 'origin/master',
16    repo: 'git@github.com:Unitech/eip-vitrine.git',
17    path: '/var/www/test-dev'
18  }
19};
20
21// Invoke deployment for `dev` environment
22deployForEnv(deployConfig, 'dev', [], function (err, args) {
23  if (err) {
24    console.error('Deploy failed:', err.message);
25    return console.error(err.stack);
26  }
27  console.log('Success!');
28});
29
30// Rollback `prod` environment
31deployForEnv(deployConfig, 'prod', ['revert', 1], function (err, args) {
32  if (err) {
33    console.error('Rollback failed:', err.message);
34    return console.error(err.stack);
35  }
36  console.log('Success!');
37});

API

Table of Contents

• deployForEnv
  • Parameters
• DeployCallback
  • Parameters

deployForEnv

Deploy to a single environment

Parameters

• deployConfig object object containing deploy configs for all environments
• env string the name of the environment to deploy to
• args array custom deploy command-line arguments
• cb DeployCallback done callback

Returns boolean return value is always false

DeployCallback

Type: Function

Parameters

• error Error deployment error
• args array custom command-line arguments provided to deploy