grunt-github-changes
Grunt plugin to generates changelog using Github Changes
Getting Started
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-github-changes --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "githubChanges" task
Overview
In your project's Gruntfile, add a section named githubChanges
to the data object passed into grunt.initConfig()
.
grunt
Options
All options that are valid with github-changes can be used here.
Usage Examples
Using Options in task
The only necessary fields are owner and repository, and the rest are optional. Below is how they can be passed in if desired. For more documentation on each field see the github-changes repo.
grunt
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
(Nothing yet)
License
Copyright (c) 2015 Nick Weingartner. Licensed under the MIT license.