Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.33 KB

README.md

File metadata and controls

70 lines (50 loc) · 2.33 KB
Raw

grunt-conventional-changelog Build Status

Generate a changelog from git metadata, using these conventions.

Example output

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

Defaults to CHANGELOG.md. The destination to write the changelog.

prepend

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

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.

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