grunt-msrelease-deploy v1.0.0

grunt-msrelease-deploy

Grunt deploy plugin for MS Release

Getting Started

This plugin requires Grunt ~0.4.5

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-msrelease-deploy --save-dev

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

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

The "msrelease_deploy" task

Overview

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

grunt.initConfig({
  msrelease_deploy: {
    taskname: {
      options: {
        url: '',
        key: '',
        version: '',
        alias: ''
      },
      src: 'package.zip'
    },
  },
});

Options

You can run the deployment without options. It'll then ask you all the details it needs to know. You must always specify a package.

options.url

Type: String Default value: ''

The url to deploy your package to. The url must start with either http:// or https://. You can find your deploy url in the MS Release Joomla! component.

options.key

Type: String Default value: ''

Your deployment key. You must setup one in the options of MS Release. A key may not be empty.

options.version

Type: String Default value: ''

Your software's new version. You can either manually specify it everytime you deploy by leaving it empty or use, for example, your package.json version by using <%= pkg.version %>

options.alias

Type: String Default value:

The extension alias you are deploying to.

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

v1.0.0 Initial plugin