Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
tasks
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-modulus-deploy

Allows deployment to modulus.io from 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-modulus-deploy --save-dev

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

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

Environment Variables

This plugin requires you add environment variables to authenticate with modulus.

MODULUS_TOKEN

  • The API Token that gives access to deploy to the specified project. Please see here for documentation on how to create an API Token.

The "modulus-deploy" task

Overview

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

grunt.initConfig({
  modulus-deploy: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.project

Type: String

The name of the modulus project to deploy.

Usage Examples

Default Options

In this example, a target stage is defined. When the task runs, it attempts to deploy the site to the modulus project named my-site-stage

grunt.initConfig({
  modulus-deploy: {
    stage: {
      options: {
        project: "my-site-stage"
      }
    },
  },
});

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)

Something went wrong with that request. Please try again.