Generates a change log for maven projects using git
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.editorconfig
.gitignore
.travis.yml Adding travis-ci build Jan 12, 2013
CONTRIBUTING.md Updated the release plugin Mar 28, 2015
README.md update readme Nov 23, 2017
pom.xml Updated plugin versions Nov 17, 2018

README.md

Build Status

Overview

This plugin allows the creation of text and HTML changelogs based on the git log. During the Maven packaging phase this plugin can generate plaintext and HTML reports showing all the commits (with tags) from the local git repository. These text files can then be sent to a web server or included during packaging.

Using as a reporting plugin (with maven 3.1+), the site generation will include the generated gitlog. In this case, the outputDirectory parameter can not be set.

Note: when using together with the reporting plugin named changelog, it is advised to change the simpleHTMLChangeLogFilename parameter to gitlog.html.

Usage instructions and Documentation

See the Maven Gitlog Plugin documentation for usage and more information.

Merge Log Only

For release notes with only merged branches.

                 <configuration>
                 
                        <fullGitMessage>false</fullGitMessage>
                        <mergeCommitFilter>false</mergeCommitFilter>
                        <excludeCommitsPattern>^(?!Merge branch.*).*$</excludeCommitsPattern>
                        
                    </configuration>

AsciiDoc Table View and special title hierarchy

For release notes with only merged branches.

                 <configuration>
                 
                        <asciidocTableView>true</asciidocTableView>
                        <asciidocTableViewHeader1>Date</asciidocTableViewHeader1>
                        <asciidocTableViewHeader2>Merge</asciidocTableViewHeader2>
                        
                    </configuration>