pm2-deploy

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

var deployForEnv = require('pm2-deploy').deployForEnv;

// Define deploy configuration with target environments
var deployConfig = {
  prod: {
    user: 'node',
    host: '212.83.163.168',
    ref: 'origin/master',
    repo: '[e-mail]:Unitech/eip-vitrine.git',
    path: '/var/www/test-deploy'
  },
  dev: {
    user: 'node',
    host: '212.83.163.168',
    ref: 'origin/master',
    repo: '[e-mail]:Unitech/eip-vitrine.git',
    path: '/var/www/test-dev'
  }
};

// Invoke deployment for `dev` environment
deployForEnv(deployConfig, 'dev', [], function (err, args) {
  if (err) {
    console.error('Deploy failed:', err.message);
    return console.error(err.stack);
  }
  console.log('Success!');
});

// Rollback `prod` environment
deployForEnv(deployConfig, 'prod', ['revert', 1], function (err, args) {
  if (err) {
    console.error('Rollback failed:', err.message);
    return console.error(err.stack);
  }
  console.log('Success!');
});

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

Similar packages

Other packages similar to pm2-deploy

shipit

Shipit is an automation engine and a deployment tool that offers a similar feature set to pm2-deploy. It provides easy rollbacks, task definitions, and workflow automation. Unlike pm2-deploy, which is tightly coupled with PM2, Shipit can be used independently of any process manager.

capistrano

Capistrano is a remote server automation and deployment tool written in Ruby. It supports scripting and task automation and is often used for deploying web applications. It is more established than pm2-deploy but requires Ruby environment, whereas pm2-deploy is specific to Node.js environments.

deployer

Deployer is a PHP deployment tool with support for several popular frameworks. It is similar to pm2-deploy in that it automates deployment tasks but is used in PHP environments. Deployer offers parallel deployment, atomic deployment, and zero downtime deployments.