grunt-conventional-changelog
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

grunt-conventional-changelog

Generate a changelog using conventional-changelog

6.1.0  •  Updated 2 years ago  •  by Brian Ford  •  MIT License

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.

Install

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

Usage

grunt.loadNpmTasks('grunt-conventional-changelog');

grunt.initConfig({
  conventionalChangelog: {
    options: {
      changelogOpts: {
        // conventional-changelog options go here
        preset: 'angular'
      },
      context: {
        // context goes here
      },
      gitRawCommitsOpts: {
        // git-raw-commits options go here
      },
      parserOpts: {
        // conventional-commits-parser options go here
      },
      writerOpts: {
        // conventional-changelog-writer options go here
      }
    },
    release: {
      src: 'CHANGELOG.md'
    }
  }
});

grunt.registerTask('default', ['conventionalChangelog']);

API

See the conventional-changelog docs.

There are some changes:

changelogOpts

warn

It is grunt.verbose.writeln.

Edit your changelog manually

Sometimes after auto-generating the changelog you want to be able to review the generated changes or add some notes to the current release, you can polish your changelog manually without changing your workflow (you might use grunt-release in the workflow but need grunt to wait until you have finished polishing your changelog).

Here are some examples of how to achieve this.

grunt.initConfig({

  // grunt-shell
  shell: {
    changelog: {
      options: {
        stdinRawMode: true
      },
      command: 'subl -w CHANGELOG.md',
    }
  },

  // or grunt-spawn
  spawn: {
    changelog: {
      command: 'vim',
      pattern: 'CHANGELOG.md',
      commandArgs: ['{0}'],
      opts: {
        stdio: 'inherit'
      }
    }
  },

});

...

grunt.registerTask('publish', ['conventionalChangelog', 'shell:changelog', 'release']);

// or

grunt.registerTask('publish', ['conventionalChangelog', 'spawn:changelog', 'release']);

License

MIT

Popularity

Weekly Downloads
3.3K
Stars
238

Maintenance

Development

Last ver 4 years ago
Created 7 years ago
Last commit 4 years ago
9 days between commits

Technology

Node version: 4.2.6
0 unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

16 contributors
Steve Mao
Maintainer, 53 commits, 1 merges, 2 PRs
Works at Cthroo & fp-works
Brian Ford
Maintainer, 18 commits, 1 merges
Andy Joslin
Maintainer, 15 commits, 3 merges, 3 PRs
Pascal Hartig
Maintainer, 9 commits, 3 merges, 1 PRs
Works at facebook
Vojta Jina
Maintainer, 10 commits, 1 merges, 1 PRs
Johannes Troeger
2 commits, 2 PRs

Tags

grunt
gruntplugin
conventional-changelog
conventional
changelog
log
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.