grunt-launch

grunt-launch is an application deployment framework based on bengourley/launch but built for Grunt.

npm install grunt-launch
32 downloads in the last week
62 downloads in the last month

grunt-launch

grunt-launch is an application deployment framework based on bengourley/launch but built for Grunt.

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-launch');

The "launch" task

Overview

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

grunt.initConfig({
  launch: {
    info: {
      options: {
        branch: 'deploy52',
        git: true,
        remote: '?',
        remotepath: '~/',
        sitePath: '/var/www',
        tempDir: '/tmp/my-proj-launch/'
      }
    },
    installDependencies: true,
    createVersionedDir: true,
    moveTempToVersioned: true,
    symbolicLink: true
  },
})

Options

info.options.branch

Type: String Default value: ``

The branch to checkout from the repo.

info.options.git

Type: Boolean Default value: ``

Whether or not to use git to deploy.

When git: true, you will need to add a post-receive hook to call grunt launch on the server when you push.

TODO: Add example of post-receive hook.

info.options.sitePath

Type: String Default value: ``

The folder to which to deploy the project.

info.options.tempDir

Type: String Default value: /tmp/[project-name]-launch

The temporary folder for staging files.

TODO: Add details for each step - removeOldTempDir, etc.

Usage Examples

Default Options

grunt.initConfig({
  launch: {
    info: {
      options: {}
    },
    installDependencies: true,
    createVersionedDir: true,
    moveTempToVersioned: true,
    symbolicLink: true
  },
})

Custom Options

TODO: Add custom option example.

grunt.initConfig({
  launch: {
    options: {
    },
    installDependencies: true,
    createVersionedDir: true,
    moveTempToVersioned: true,
    symbolicLink: true
  },
})

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

(Nothing yet)

npm loves you