Wondering what’s next for npm?Check out our public roadmap! »


    0.5.2 • Public • Published


    A grunt task to generate changelog from git repository. You could provide a start and end tag and it will find all commits between these tags. Or you could only provide end tag (and it will take previous take as start tag) By default if no tag are specified, it will take 2 weeks of commits. See example of generated file here : link Based on grunt-changelog project.

    Getting Started

    This plugin requires Grunt ~0.4.5

    If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install grunt-changelog-customizable --save-dev

    Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:


    The "changelog_customizable" task


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

      changelogcustomizable: {
        changelog: {
          options: {
            // Task-specific options go here.



    Type: String Default value: null

    A string value that is a date or a git tag In case of git tag and if options.start is empty then get previous tag as options.start


    Type: String Default value: null

    A string value that is a date or a git tag. Can be empty if options.end is a git tag. In that case previous git tag will be used as start value.

    git describe --abbrev=0 tagname^


    Type: String Default value: 'Changelog'

    A string value that is put as generated file's header


    Type: Object Default value: see usage examples

    A object to describe destination file


    Type: String Default value: 'dev'

    A string to define what kind of changelog to generate. This string should correspond to one of your options.templates regex key (see usage examples) In usage examples we use two different keys, 'dev' and 'release' and each one have a different regex to find commits. If you want to generate all changelog, put 'all' in this property.


    Type: String Default value: empty

    A string to determine if we add changelog to destination file or if we erase content. Can be :

    • empty : replace file content
    • "append": insert content to the end of file
    • "prepend": insert content to the beginning of file


    Type: String Default value: automatically generated

    Defines the global template of generated file. If not specified the default value is automatically generated with options.templates. In most cases you don't really need to explicitly specified a value in this field. It accepts a template like the following :

    {{> features}}{{> fixes}}


    Type: Object Default value: see Usage examples

    Defines all templates needed to generate your file.

    Usage Examples

    Default Options

      changelogcustomizable: {
        changelog: {
          options: {
            start: null,
            end: null,
            header: 'Changelog',
            dest: {
              dir: './release-notes/',
              fileName: 'changelog',
              extension: 'md'
            type: 'dev',
            templates: {
              features: {
                regex: {
                  dev: /^(.*)feature(.*)$/gim,
                  release: /^(.*)release(.*)feature(.*)$/gim
                template: '##FEATURE:\n\n{{#if features}}{{#each features}}{{> feature}}{{/each}}{{else}}{{/if}}\n'
              feature: {
                template: '\t{{{this}}}\n'
              fixes: {
                regex: {
                  dev: /^(.*)fixes #\d+:?(.*)$/gim,
                  release: /^(.*)release(.*)fixes #\d+:?(.*)$/gim
                template: '##FIXES:\n\n{{#if fixes}}{{#each fixes}}{{> fix}}{{/each}}{{else}}{{/if}}\n'
              hotfixes: {
                regex: {
                  dev: /^(.*)hotfix #\d+:?(.*)$/gim
                template: '##HOT FIXES:\n\n{{#if hotfixes}}{{#each hotfixes}}{{> fix}}{{/each}}{{else}}{{/if}}\n'
              fix: {
                template: '\t{{{this}}}\n'

    will generate the following file :

       first changelog generation with basic options
       commit readme and configuration files
        first fix
        second fix


    Any help is welcome :)


    npm i grunt-changelog-customizable

    DownloadsWeekly Downloads






    Last publish


    • avatar