grunt-pm2-deploy

Deploy node application with pm2-deploy

What this is

• A simple grunt task for pm2 deployment system
• This task executes pm2 deploy command. Task target will be used as the environment.
• If remote server has to be setup, this task does it.

Usage

As for this ecosystem.json,

1{
2  "apps" : [{
3    "name"      : "API",
4    "script"    : "app.js",
5    "env": {
6      "COMMON_VARIABLE": "true"
7    },
8    "env_production" : {
9      "NODE_ENV": "production"
10    }
11  },{
12    "name"      : "WEB",
13    "script"    : "web.js"
14  }],
15  "deploy" : {
16    "production" : {
17      "user" : "node",
18      "host" : "212.83.163.1",
19      "ref"  : "origin/master",
20      "repo" : "git@github.com:repo.git",
21      "path" : "/var/www/production",
22      "post-deploy" : "pm2 startOrRestart ecosystem.json --env production"
23    },
24    "dev" : {
25      "user" : "node",
26      "host" : "212.83.163.1",
27      "ref"  : "origin/master",
28      "repo" : "git@github.com:repo.git",
29      "path" : "/var/www/development",
30      "post-deploy" : "pm2 startOrRestart ecosystem.json --env dev",
31      "env"  : {
32        "NODE_ENV": "dev"
33      }
34    }
35  }
36}

these commands are available:

1$ grunt pm2deploy:production # deploy using production env
2$ grunt pm2deploy:dev # deploy using dev env

Installation

1$ npm install grunt-pm2-deploy --save-dev

pm2deploy task

Run this task with the grunt pm2deploy command.

Options

ecosystemFile

Type: String
Default: 'ecosystem.json'

ecosystem file name. require-able files (*.js, *.json) can be used.

Tests

To run the test suite, first install the dependencies, then run npm test:

1$ npm install
2$ npm test

License

MIT