grunt-deploy-semver

grunt-deploy-semver v0.1.0.

Deploy easier using Semantic Versioning.

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

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

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

grunt-deploy-semver calculates a new version number for you, by passing --major=1, --minor=1 or --patch=1. You no longer need to check what the latest tag is and figure out what the next version should be. Two configurable functions run after and before the deploy, allowing you to let other grunt tasks to be run depending on the newly calculated version and other passed arguments such as --soft=1, --debug=1, etc.

Deploy task

Run this task with the grunt deploy command.

When to actually run it

Once you made one or more commits which you consider ready to deploy. Make sure your working directory is clean by running git status before running the deploy command. You should never tag or make release commits yourself using this task.

Arguments

--major=1

Increments the major version number x.0.0 and sets minor and patch to 0;

--minor=1

Increments the minor version number 0.x.0 and sets patch to 0;

--patch=1

Increments the patch version number 0.0.x;

--force-version=x

Allows you to set a custom version, e.g. --force-version=1.23.0-bluestyle

--soft=1

Using this option, commits and tags will be created but nothing will be pushed. Note that you need to manually include logic in your preDeployFn and postDeployFn to check for this option as to not do a normal deploy.

Options

versionFiles

Type: Array Default: []

An array of filenames which this task should open and edit the version field to match the latest version. Usually these will be package.json and/or bower.json.

masterBranch

Type: String Default: master

The default branch to push to. When null, nothing is pushed except the tag.

tagOnly

Type: Boolean Default: false

When true, only tags and pushes the tag. There will be no release commit inside your current branch.

preDeployFn

Type: Function Default: null

This function will be run when the deploy task calculated the new version, but before creating the commit and tag. It will pass in the grunt object, the new version number and a done function respectively. You need to call done() when you are done! This is to make sure grunt waits for any asynchronous calls you make inside this function. You can use this function to run additional grunt tasks, set config variables, and more.

postDeployFn

Type: Function Default: null

This function will be run when the deploy task has made the commit and tag and has pushed. It will pass in the grunt object, the new version number and a done function respectively. You need to call done() when you are done! This is to make sure grunt waits for any asynchronous calls you make inside this function. You can use this function to run additional grunt tasks, set config variables, and more.

Example:

deploy: {
    options: {
        versionFiles: [
            'package.json',
            'bower.json'
        ],
        preDeployFn: function (grunt, newVersion, done) {
            grunt.task.run([
                'build',
                'changelog'
            ]);
            done();
        },
        postDeployFn: function (grunt, newVersion, done) {
            if (!grunt.option('soft')) {
                var exec = require('child_process').exec;
                exec('npm publish', null, function (err, stdout) {
                    console.log(stdout);
                    done();
                });
            }
            else {
                done();
            }
        }
    }
}