maven-auto-changelog

Maven changelog generator

License	Apache License, Version 2.0
Categories	Maven Build Tools Auto Application Layer Libs Code Generators
GroupId	cz.encircled
ArtifactId	maven-auto-changelog
Last Version	0.3.23
Release Date	Feb 18, 2018
Type	maven-plugin
Description	maven-auto-changelog Maven changelog generator
Project URL	https://github.com/encircled/MavenAutoChangelog
Source Code Management	https://github.com/encircled/MavenAutoChangelog.git

Download maven-auto-changelog

Filename	Size
maven-auto-changelog-0.3.23.pom
maven-auto-changelog-0.3.23.jar	22 KB
maven-auto-changelog-0.3.23-sources.jar	10 KB
maven-auto-changelog-0.3.23-javadoc.jar	98 KB

How to add to project

Apache Maven

<plugin>
    <groupId>cz.encircled</groupId>
    <artifactId>maven-auto-changelog</artifactId>
    <version>0.3.23</version>
</plugin>

Dependencies

compile (2)

Group / Artifact	Type	Version
org.apache.commons : commons-lang3	jar	3.7
org.apache.maven : maven-plugin-api	jar	3.0

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.4

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

Changelog auto generator - maven plugin

MavenAutoChangelog is a simple maven plugin which generates changelog entries from git commit messages.

It can be configured to add only such messages which meet some format;

Running

Maven goal generate-changelog.

Configuration

Maven plugin properties:

• pathToChangelog - Path to changelog file. Default is CHANGELOG.md
• lastTag - Predefined git tag which is used for comparing. Alternatively, lastTagPattern may be used to parse latest tag dynamically
• lastTagPattern - Regexp pattern which is used to match line with latest release version (tag). Alternatively, lastTag may be used if tag is predefined
• lastTagFormat - Defines format (for java String.format(lastTagFormat, lastTagPattern)) which is used to customize git tag if differs from lastTagPattern
• applicableCommitPattern - Regexp pattern which is used to filter unwanted commits, i.e. only commits which match this regexp will be included into changelog
• commitFormat - Additional java String.format(commitMessage, commitFormat) which can be used to customize changelog entry. Default is %s
• unreleasedRowPattern - Regexp pattern which should be used to match line with 'Unreleased' token
• mergeRequestReplacePattern - Regex pattern which is used to add merge request numbers to the messages. It must match the group which will be referenced in mergeRequestReplacement. For example (]) to add merge requests before first ] like [ABC-123] Text ==> [ABC-123 321!] Text.
• mergeRequestReplacement - Replacement string which will be used with mergeRequestReplacePattern. Must contain token MR#, which will be replaced by merge request number. Default is " MR#$1"
• incrementVersionAfterRun - If true, add line with auto-incremented version after changelog generation

Sample

For example you have a CHANGELOG.md looking like

[Unreleased]

[1.02] - 2017.01.02
- (FIX 20!) Critical bug fix
- (FEATURE 18!) Some cool feature
[1.01] - 2017.01.01
- (FEATURE 16!) Some cool feature

Your configuration may look like:

• unreleasedRowPattern - .*[Unreleased]
• lastTagPattern - .*[\d.] - .*
• applicableCommitPattern - \(.*).*
• commitFormat - - %s
• mergeRequestReplacePattern - (\\))

Versions

Version
0.3.23 Feb 18, 2018
0.3.22 Dec 5, 2017
0.3.21 Dec 3, 2017
0.3.20 Nov 23, 2017
0.3.19 Nov 21, 2017
0.3.18 Nov 11, 2017
0.3.17 Nov 8, 2017
0.3.16 Nov 2, 2017
0.3.15 Oct 28, 2017
0.3.13 Aug 10, 2017
0.3.12 Aug 10, 2017
0.3.11 Jul 17, 2017
0.3.10 Jul 14, 2017
0.3.9 Jun 27, 2017
0.3.8 Jun 26, 2017
0.3.7 Jun 26, 2017
0.3.5 Jun 24, 2017
0.3.4 Jun 24, 2017
0.3.3 Jun 23, 2017