https://github.com/iwatakeshi/gulp-changelog

Dylang's changelog for gulp.
https://github.com/iwatakeshi/gulp-changelog

Last synced: 6 days ago
JSON representation

Dylang's changelog for gulp.

• Host: GitHub
• URL: https://github.com/iwatakeshi/gulp-changelog
• Owner: iwatakeshi
• License: mit
• Created: 2015-08-31T15:21:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-11-03T16:22:54.000Z (about 6 years ago)
• Last Synced: 2024-12-21T16:25:04.316Z (17 days ago)
• Language: JavaScript
• Homepage: https://github.com/dylang/changelog
• Size: 4.88 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-changelog

[Dylang's changelog](https://github.com/dylang/changelog) for gulp.

[![Build Status](https://travis-ci.org/iwatakeshi/gulp-changelog.svg)](https://travis-ci.org/iwatakeshi/gulp-changelog)

## Usage

```

npm install gulp-changelog

```

## API

### fn(source, options)

```javascript

/**

 * Creates a changelog as a markdown file by retrieving the source.

 * @param {object|string} source - The package.json file or package name

 * @param {object} options - The options to set the plugin.

 */

```

## Example

```javascript

var gulp = require('gulp'),

	changelog = require('gulp-changelog');

gulp.task('changelog', function(cb){

  changelog(require('./package.json')).then(function(stream) {

    stream.pipe(gulp.dest('./')).on('end',cb);

  });

});

```

## Options

```javascript

{

	// The integer or semver, optional Number of versions, 

	// or the semver version to show

	'number': 15,

	// The file name of the changelog

	'filename': 'CHANGELOG'

}

```