pm2-deploy

What is pm2-deploy?

The pm2-deploy npm package is a module for PM2, which allows users to perform deployment tasks for their applications. It simplifies the process of updating, reverting, and managing deployments directly from the command line.

What are pm2-deploy's main functionalities?

Setup

Initializes the remote production environment, setting up the necessary directories and configurations for deployment.

pm2 deploy production setup

Deployment

Deploys the application to the production environment as specified in the ecosystem configuration file.

pm2 deploy ecosystem.config.js production

Update

Updates the deployment with the latest changes from the source without a full redeployment.

pm2 deploy production update

Revert

Reverts to the previous deployment (or a specified number of revisions back) in case of deployment issues.

pm2 deploy production revert 1

Execution of custom commands

Executes a custom command on the remote server, such as reloading all PM2 processes.

pm2 deploy production exec 'pm2 reload all'

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.

README

Deploy system for PM2

Documentation: https://pm2.io/doc/en/runtime/guide/easy-deploy-with-ssh/

Instalation

$ npm install pm2-deploy

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