grunt-hg-release

Release a new version of your Node-based project using hg/Mercurial

Grunt task to automate the following tasks:

• Bump version in package.json
• Commit to HG repo
• Tag HG repo

Getting Started

This plugin requires Grunt ~0.4.2

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-hg-release --save-dev

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

grunt.loadNpmTasks('grunt-hg-release');

The "hg_release" task

Overview

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

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

Options

options.commit

Type: String Default value: '{{version}}'

options.tag

Type: String Default value: '{{version}}'

The tag commit message.

Usage Examples

Patch release:

grunt hg_release

or

grunt hg_release:patch

Minor release:

grunt hg_release:minor

Major release:

grunt hg_release:major

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

• 2015-05-26 v0.2.2 Overwriting grunt templates as options doesn't work, so use different template syntax.
• 2014-07-03 v0.2.1 Bumped version after pull request merge.
• 2014-07-03 v0.2.0 Log the new version to the console.
• 2014-01-16 v0.1.1 Fixed commit process.
• 2014-01-16 v0.1.0 Initial release.