Interactive release task for Git repositories. Optionally release a build to distribution/component repository.
Interactive release tool for Git repositories. Publish to npm. Optionally build and release to a distribution/component repository.
Automatically increments version in package.json, commit, tag, push, publish, done.
This is the Grunt plugin of Release It!
This plugin requires Grunt
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-it --save-dev
See the Release It! for configuration options.
In your project's Gruntfile, add a section named
release-it to the data object passed into
grunt.initConfig(). These are the options with their default values:
gruntinitConfig'release-it':options:pkgFiles: 'package.json'commitMessage: 'Release %s'tagName: '%s'tagAnnotation: 'Release %s'buildCommand: false;
If you also want to release to "distribution repo", you'll need to provide the
distRepo as well. Here are the additional options with their default values:
options:distRepo: falsedistStageDir: '.stage'distFiles: 'dist/**/*'distBase: 'dist'publish: false;
You must set
distRepo to a git endpoint (e.g.
Make a "patch" release (increments the 0.0.x):
Make a patch, minor, major or specific version release with e.g.:
grunt release-it:minorgrunt release-it:0.8.3grunt release-it:2.0.0-rc.3
You can also do a dry run, which won't write/touch anything, but does output the commands it would execute, and shows the interactivity:
grunt release-it --no-write
The Grunt options
--debug or passed as-is, while
--no-write is passed as
--dry-run to Release It!