grunt-fabric-deploy

Provides Fabric (python) like deploy tasks

npm install grunt-fabric-deploy
4 downloads in the last week
16 downloads in the last month

grunt-fabric-deploy v0.0.3

Provides Fabric (python) like deploy tasks

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-fabric-deploy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-fabric-deploy');

*This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade.

Deploy task

Run this task with the grunt deploy command.

Options

stdout

Type: Boolean false Default: 'false'

Boolean switch for showing the output of each command.

Example:

options: {
  stdout: true
}

failOnError

Type: Boolean false Default: 'false'

Boolean switch for failing on an error.

Example:

options: {
  failOnError: true
}

Usage Examples

deploy: {
  options: {
    variables: {
      packed: 'filename'
      host: 'server.com',
      port: 22,
      user: 'deploy_user'
    }
  },
  pack: {
    local: '/usr/bin/gnutar -zcf /tmp/{packed}.tar.gz -C ./ .'
  },
  upload: {
    put: {
      src: '/tmp/{packed}.tar.gz',
      dest: '/tmp/{packed}.tar.gz'
    },
    run: [
      'rm -rf /tmp/{packed}',
      'mkdir -p /tmp/{packed}',
      'tar -zxf /tmp/{packed}.tar.gz -C /tmp/{packed}',

      'rm -rf /srv/www/server.com/public',
      'mkdir -p /srv/www/server.com/public',
      'mv /tmp/{packed}/* /srv/www/server.com/public/'
    ]
  }
}

Release History

  • 2013-10-03   v0.0.3   Better docs Refactor Grouping
  • 2013-10-03   v0.0.2   Added stdout + failOnError options
  • 2013-10-02   v0.0.1   Initial version

Task submitted by Pieter Michels

This file was generated on Thu Oct 03 2013 17:17:50.

npm loves you