phnz / grunt-conventional-changelog

Grunt task for generating a changelog from git metadata

grunt-conventional-changelog

Generate a changelog using connvetional-changelog.

Uses git metadata, based on these commit conventions.

View conventional-changelog/CONVENTIONS.md for a synposis of the conventions with commit examples.

Example output

• https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md
• https://github.com/karma-runner/karma/blob/master/CHANGELOG.md

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

Supports all options from conventional-changelog, with the following changes and additions:

dest

Defaults to CHANGELOG.md. The destination to write the changelog, and to read the existing changelog from.

version

Defaults to version in grunt.config('pkg') or package.json.

repository

Defaults to repository or repository.url, found in grunt.config('pkg') or package.json.

By default, it expects a github repository. Check conventional-changelog's README for information on using non-github repositories.

editor

If specified, it runs given command before finishing the task. This is useful if you want to manually polish the generated changelog.

For instance you can set it to sublime -w.

License

BSD