grunt-release-steps v0.3.7

grunt-release

Grunt plugin for automating all the release steps of your node lib or bower component, with optional publishing to npm.

Repetition Killed the Cat

Releasing a new version of your killer Node lib looks like this:

1. bump the version in your package.json file.
2. stage the package.json file's change.
3. commit that change with a message like "release 0.6.22".
4. create a new git tag for the release.
5. push the changes out to github.
6. also push the new tag out to github.
7. publish the new version to npm.

Cool, right? No! What's wrong with you? Automate all that:

grunt release

Done. No more github issues reminding you how often you forget to do one or more of the steps.

Setup

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

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

grunt.loadNpmTasks('grunt-release');

Using grunt-release

Patch Release:

grunt release

or

grunt release:patch

Minor Release:

grunt release:minor

Major Release:

grunt release:major

Options

You can disable any of the steps if you want, by adding this to your Gruntfile:

  release: {
    options: {
      bump: false, //default: true
      file: 'component.json', //default: package.json
      add: false, //default: true
      commit: false, //default: true
      tag: false, //default: true
      push: false, //default: true
      pushTags: false, //default: true
      npm: false, //default: true
      folder: 'folder/to/publish/to/npm' //default project root
      tagName: 'some-tag-<%= version %>', //default: '<%= version %>'
      commitMessage: 'check out my release <%= version %>', //default: 'release <%= version %>'
      tagMessage: 'tagging version <%= version %>' //default: 'Version <%= version %>'
    }
  }

For node libs, leave file option blank. For bower components, set it to component.json or whatever you've set your bower config file to be.

Credits

Inspired by Vojta Jina's grunt-bump.

License

MIT