Check that we are on a correct Git branch before proceeding.
This plugin requires Grunt ~0.4.1
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-checkbranch --save-devOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-checkbranch');Include the task as one of your multitasks, optionally passing the desired branch (default: master) after a colon, e.g.:
grunt.registerTask("default", ["test", "checkbranch:develop", "deploy"]In the example above, the deploy task will only be executed, if your project is currently on the develop branch - otherwise the run will result in a fatal error.
You may override this behavior by passing --no-checkbranch via command line. You can disable --no-checkbranch (i.e. force the check) by setting a second param for the task, e.g. checkbranch:master:true.
You may also negate the test, i.e. exclude a specific branch by prepending an exclamation mark, e.g. "checkbranch:!develop".
- Added support for negating a branch, i.e. "run everywhere except X" (thx @Pleochism)
- Added tests
- Second bool param to force the check.
- Initial release (after a few removed, buggy ones)