grunt-deployinator

Grunt plugin that deploys git repositories on remote servers.

Getting Started

This plugin requires Grunt ~0.4.4

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-deployinator --save-dev

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

grunt.loadNpmTasks('grunt-deployinator');

The "deployinator" task

Overview

In your project's Gruntfile, add a section named deployinator to the data object passed into grunt.initConfig().

deployPull task:

grunt.initConfig({
    deployPull: {
        app: {
            options: {
                host: "yourhost",
                directory: "/opt/location-of-your-repository",
                buildCommands: ["npm install", "grunt build"]
            }
        }
    }
});

deployPush task:

grunt.initConfig({
    deployPush: {
        app: {
            options: {
                remote: 'deploy master'
            }
        }
    }
});

tagRelease task will only create a tag for the release.

Options

options.host (deployPull)

The ssh host of the production system.

options.directory (deployPull)

Location of the production source location on the production system.

options.remote (deployPush)

Git remote repository to push to.

Command line options

By default deployinator will increment the last(patch) version number. With --release deployinator will increment the second(minor release) number. With --majorRelease it will increment the first(major release) number.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1.0 initial version that is capabil of performing the deployment