Switch branches/tags
v1.1.0 v1.0.2 v1.0.1 v1.0.0 v0.5.3 v0.5.2 v0.5.1 v0.5.0 v0.4.3 v0.4.2 v0.4.1 v0.4.0 v0.3.2 v0.3.1 v0.3.0 v0.2.1 v0.2.0 v0.1.3 v0.1.2 v0.1.1 v0.1.0 v0.1.0-beta.3 v0.1.0-beta.2 v0.1.0-beta.1 v0.1.0-alpha.3 v0.1.0-alpha.2 v0.1.0-alpha.1 v0.0.17 v0.0.16 v0.0.15 v0.0.14 v0.0.13 v0.0.11 v0.0.10 v0.0.9 v0.0.8 v0.0.7 v0.0.6 v0.0.5 v0.0.4 standard-changelog@2.0.1 standard-changelog@2.0.0 standard-changelog@1.0.19 standard-changelog@1.0.18 standard-changelog@1.0.17 standard-changelog@1.0.16 standard-changelog@1.0.15 standard-changelog@1.0.14 standard-changelog@1.0.13 standard-changelog@1.0.12 standard-changelog@1.0.11 standard-changelog@1.0.10 standard-changelog@1.0.9 standard-changelog@1.0.8 standard-changelog@1.0.7 standard-changelog@1.0.6 standard-changelog@1.0.5 standard-changelog@1.0.4 standard-changelog@1.0.3 standard-changelog@1.0.2 standard-changelog@1.0.1 standard-changelog@1.0.0 standard-changelog@0.0.2 @marionebl/conventional-commits-parser@3.0.0 gulp-conventional-changelog@2.0.3 gulp-conventional-changelog@2.0.2 gulp-conventional-changelog@2.0.1 gulp-conventional-changelog@2.0.0 gulp-conventional-changelog@1.1.24 gulp-conventional-changelog@1.1.23 gulp-conventional-changelog@1.1.22 gulp-conventional-changelog@1.1.21 gulp-conventional-changelog@1.1.20 gulp-conventional-changelog@1.1.19 gulp-conventional-changelog@1.1.18 gulp-conventional-changelog@1.1.17 gulp-conventional-changelog@1.1.16 gulp-conventional-changelog@1.1.15 gulp-conventional-changelog@1.1.14 gulp-conventional-changelog@1.1.13 gulp-conventional-changelog@1.1.12 gulp-conventional-changelog@1.1.11 gulp-conventional-changelog@1.1.10 gulp-conventional-changelog@1.1.9 gulp-conventional-changelog@1.1.8 gulp-conventional-changelog@1.1.7 gulp-conventional-changelog@1.1.6 gulp-conventional-changelog@1.1.5 gulp-conventional-changelog@1.1.4 gulp-conventional-changelog@1.1.3 gulp-conventional-changelog@1.1.2 gulp-conventional-changelog@1.1.1 gulp-conventional-changelog@1.1.0 git-semver-tags@2.0.0 git-semver-tags@1.3.6 git-semver-tags@1.3.5 git-semver-tags@1.3.4 git-semver-tags@1.3.3 git-semver-tags@1.3.2 git-semver-tags@1.3.1
Nothing to show
Find file History
hbetts chore(release): publish
 - conventional-changelog-angular@5.0.1
 - conventional-changelog-cli@2.0.3
 - conventional-changelog-core@3.1.0
 - conventional-changelog-ember@2.0.1
 - conventional-changelog-jquery@3.0.1
 - conventional-changelog@2.0.3
 - gulp-conventional-changelog@2.0.3
 - standard-changelog@2.0.1
Latest commit e34994b Aug 21, 2018

README.md

gulp-conventional-changelog NPM version Build Status Dependency Status Coverage Status

Generate a changelog using conventional-changelog

Issues with the output should be reported on the conventional-changelog issue tracker.

Checkout the gulp official recipe to automate releases with gulp and gulp-conventional-changelog.

Install

$ npm install --save-dev gulp-conventional-changelog

Usage

var gulp = require('gulp');
var conventionalChangelog = require('gulp-conventional-changelog');

gulp.task('changelog', function () {
  return gulp.src('CHANGELOG.md')
    .pipe(conventionalChangelog({
      // conventional-changelog options go here
      preset: 'angular'
    }, {
      // context goes here
    }, {
      // git-raw-commits options go here
    }, {
      // conventional-commits-parser options go here
    }, {
      // conventional-changelog-writer options go here
    }))
    .pipe(gulp.dest('./'));
});

streaming mode

gulp.task('changelog', function () {
  return gulp.src('CHANGELOG.md', {
    buffer: false
  })
    .pipe(conventionalChangelog({
      preset: 'angular'
    }))
    .pipe(gulp.dest('./'));
});

buffer mode

gulp.task('changelog', function () {
  return gulp.src('CHANGELOG.md')
    .pipe(conventionalChangelog({
      preset: 'angular'
    }))
    .pipe(gulp.dest('./'));
});

Note: If your options.releaseCount is 0 (regenerate all changelog from previous releases) you can just use conventional-changelog directly or not to read the file at all.

var gulp = require('gulp');
var conventionalChangelog = require('conventional-changelog');
var fs = require('fs');

gulp.task('default', function () {
  return conventionalChangelog({
    preset: 'angular',
    releaseCount: 0
  })
    .pipe(fs.createWriteStream('CHANGELOG.md'));
});

Or

var gulp = require('gulp');
var conventionalChangelog = require('gulp-conventional-changelog');

gulp.task('default', function () {
  return gulp.src('CHANGELOG.md', {
    read: false
  })
    .pipe(conventionalChangelog({
      preset: 'angular',
      releaseCount: 0
    }))
    .pipe(gulp.dest('./'));
});

API

See the conventional-changelog docs.

There are some changes:

changelogOpts

warn

If the cli contains flag --verbose it is fancyLog.

License

MIT © Steve Mao