grunt-conventional-changelog

Generate a changelog from git metadata.

Uses these conventions.

Getting Started

This plugin requires Grunt ~0.4.0

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-conventional-changelog --save-dev

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

grunt.loadNpmTasks('grunt-conventional-changelog');

Overview

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

grunt.initConfig({
  changelog: {
    options: {
      // Task-specific options go here.
    }
  },
})

Options

dest

The destination to write the changelog. If undefined, the changelog will be written to console.log.

prepend

Defaults to true. If true, prepend new log info to dest. If false, append new log info.

templateFile

Template to use. See the default template (used if another isn't provided) for an example of how to write your own.

github

Specifies the github repository to use to link to commits in the changelog.

By default, tries to find a github repository from the information in package.json.

Allows a full repository url, or simply username/repository.

Example configurations:

github: 'btford/grunt-conventional-changelog'

github: 'http://github.com/angular/angular.js'

version

A string which contains the value of the version which is used by grunt-conventional-changelog. If no version is specified, grunt-conventional-changelog looks for the version in pkg.version.

enforce

Enforce commit convention by using a commit-hook. based on this. By Default false.

Usage Examples

CLI

Run from the command line:

grunt changelog:from-rev:to-rev >> CHANGELOG.md

from-rev defaults to most recent tag if not provided.

to-rev defaults to HEAD if not provided.

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  changelog: {
    options: {}
  },
})

Task

Say you have the following git log --oneline:

6d6f21e feat(build): use Grunt for building Batarang
8f77864 feat(test): switch from testacular to karma
c5db59b v0.4.0
4682d4b feat(something)
...

If you run changelog with no from-rev or to-rev specified, the task will generate a changelog showing all changes from 0.4.0 to HEAD:

# 0.4.0 (2013-04-06)

## Features
### test

* switch from testacular to karma (8f77864)

### build

* use Grunt for building Batarang (6d6f21e)

License

BSD

pkozlowski-opensource / grunt-conventional-changelog