Skip to content

Commit

Permalink
fix(dest): do not ignore options.dest
Browse files Browse the repository at this point in the history
Closes #55
  • Loading branch information
stevemao committed May 2, 2015
1 parent 80d4b63 commit 1dbf0a8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ View [conventional-changelog/CONVENTIONS.md](https://github.com/ajoslin/conventi


## Example output

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

Expand All @@ -30,6 +31,7 @@ grunt.loadNpmTasks('grunt-conventional-changelog');


## Overview

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


Expand All @@ -49,9 +51,13 @@ grunt.initConfig({
Supports all options from [conventional-changelog](https://github.com/ajoslin/conventional-changelog#documentation), with the following additions:

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

Type: `string` Default: `CHANGELOG.md`.

This is an alias of `options.file`.

### editor (*deprecated*)

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 `subl -w`. **This option will be removed in the next major release. Please use [grunt-shell](https://github.com/sindresorhus/grunt-shell) or [grunt-spawn](https://github.com/fir3pho3nixx/grunt-spawn) instead.**


Expand Down Expand Up @@ -99,6 +105,7 @@ grunt.registerTask('publish', ['changelog', 'spawn:changelog', 'release']);


## License

BSD


Expand Down
2 changes: 1 addition & 1 deletion tasks/changelog.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module.exports = function(grunt) {
var done = this.async();

var options = this.options({
file: 'CHANGELOG.md',
dest: 'CHANGELOG.md',
prepend: true, // false to append
editor: null, // 'sublime -w'
github: null // deprecated
Expand Down

0 comments on commit 1dbf0a8

Please sign in to comment.