README.md

grunt-git-commit

Simple module to add files to the next git commit.

Getting Started

This plugin requires Grunt ~0.4.5

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-git-commit --save-dev

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

grunt.loadNpmTasks('grunt-git-commit');

The "git_commit" task

Overview

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

Examples

grunt.initConfig({
    git_commit: {
        options: {
            files: ['doc/**/*.md', 'coverage']
        }
    }
});

grunt.initConfig({
    git_commit: {
        options: {
            files: 'doc/**/*.md'
        }
    }
});

grunt.initConfig({
    git_commit: {
        options: {
            files: 'doc'
        }
    }
});