Nice Philanthropist Metalhead
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-conventional-changelogpublic

    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

    install

    npm i grunt-conventional-changelog

    Downloadsweekly downloads

    5,825

    version

    6.1.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar