grunt-git-contributors v0.1.5

grunt-git-contributors

Generate a list of contributors from your project's git history.

Dependencies

Unfortunately this task depends on git-extras. I'd like to get rid of the dependency as much as the next guy, but this isn't working for some reason. If you know why, or have a fix, contact me ASAP.

Getting Started

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, install this plugin with this command:

npm install grunt-git-contributors --save-dev

Contributors task

Run this task with the grunt contributors command.

This task is a multi task so any targets, files and options should be specified according to the multi task documentation.

Options

path

Type: String Default value: './AUTHORS'

The path to your contributors file.

branch

Type: String Default value: null

If your current branch doesn't match the one specified, the task will do nothing. (You probably don't want to update the contributors file when working on a development branch.)

Usage example

contributors: {
  master: {
    path: 'path/to/list_of_heroes.txt',
    branch: 'master'
  }
}

License

grunt-git-contributors is licensed under the MIT license.