Maven Git Log Plugin

Generates a changelog based on commits to a git repository in text and HTML format showing the changes that are included in each version. A possible use of this is to include these changelogs when packaging your maven project so that you have an accurate list of commits that the current package includes.

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

com.github.danielflower.mavenplugins
ArtifactId

ArtifactId

gitlog-maven-plugin
Last Version

Last Version

1.13.17
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

Maven Git Log Plugin
Generates a changelog based on commits to a git repository in text and HTML format showing the changes that are included in each version. A possible use of this is to include these changelogs when packaging your maven project so that you have an accurate list of commits that the current package includes.
Project URL

Project URL

http://github.com/danielflower/maven-gitlog-plugin

Download gitlog-maven-plugin

How to add to project

<plugin>
    <groupId>com.github.danielflower.mavenplugins</groupId>
    <artifactId>gitlog-maven-plugin</artifactId>
    <version>1.13.17</version>
</plugin>

Dependencies

compile (7)

Group / Artifact Type Version
org.apache.maven : maven-plugin-api jar 2.2.1
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.3
com.madgag : org.eclipse.jgit jar 2.99.99.2.0-UNOFFICIAL-ROBERTO-RELEASE
org.apache.commons : commons-lang3 jar 3.0.1
org.apache.maven.reporting : maven-reporting-api jar 3.0
org.apache.maven.doxia : doxia-sink-api jar 1.0
xml-apis : xml-apis jar 1.3.04

test (2)

Group / Artifact Type Version
junit : junit jar 4.11
org.hamcrest : hamcrest-core jar 1.3

Project Modules

There are no modules declared in this project.

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>

Versions

Version
1.13.17
1.13.16
1.13.15
1.13.12
1.13.8
1.13.7
1.13.6
1.13.3
1.13.2
1.12.3
1.12.0
1.11.0
1.10.1
1.10.0