cz.encircled.macl

Class ChangelogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

cz.encircled.macl.ChangelogMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-changelog",
      defaultPhase=GENERATE_RESOURCES,
      aggregator=true)
public class ChangelogMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Kisel on 22.6.2017.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	applicableCommitPattern Regex pattern which is used to filter unwanted commits, i.e.
protected String	commitFormat Additional java String.format(commitMessage, commitFormat) which is used to customize changelog entry
static List<MessageFilter>	filters
protected String	incrementVersionAfterRun If true, add line with auto-incremented version after changelog generation
protected String	lastTag Predefined git tag which is used for comparing.
protected String	lastTagFormat Defines format (for java String.format(lastTagFormat, lastTagPattern)) which is used to customize git tag if differs from lastTagPattern
protected String	lastTagPattern Regex pattern which is used to match line with latest release version (tag).
protected String	mergeRequestReplacement Replacement string which will be used with mergeRequestReplacePattern.
protected String	mergeRequestReplacePattern Regex pattern which is used to add merge request numbers to the messages.
protected String	pathToChangelog Path to changelog file
static List<MessageTransformer>	transformers
protected String	unreleasedRowPattern Regex pattern which is used to match line with 'Unreleased' token

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ChangelogMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
ChangelogConfiguration	getChangelogConfiguration()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pathToChangelog

@Parameter(defaultValue="CHANGELOG.md")
protected String pathToChangelog

Path to changelog file

lastTag

@Parameter
protected String lastTag

Predefined git tag which is used for comparing. Alternatively, lastTagPattern may be used to parse latest tag dynamically.

lastTagPattern

@Parameter
protected String lastTagPattern

Regex pattern which is used to match line with latest release version (tag). Alternatively, lastTag may be used if tag is predefined.

lastTagFormat

@Parameter(defaultValue="%s")
protected String lastTagFormat

Defines format (for java String.format(lastTagFormat, lastTagPattern)) which is used to customize git tag if differs from lastTagPattern

applicableCommitPattern

@Parameter(required=true)
protected String applicableCommitPattern

Regex pattern which is used to filter unwanted commits, i.e. only commits which match this regex will be included into changelog

commitFormat

@Parameter(defaultValue="%s")
protected String commitFormat

Additional java String.format(commitMessage, commitFormat) which is used to customize changelog entry

unreleasedRowPattern

@Parameter(required=true)
protected String unreleasedRowPattern

Regex pattern which is used to match line with 'Unreleased' token

mergeRequestReplacePattern

@Parameter
protected String 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

@Parameter(defaultValue=" MR#$1")
protected String mergeRequestReplacement

Replacement string which will be used with mergeRequestReplacePattern. Must contain token "MR#", which will be replaced by merge request number

incrementVersionAfterRun

@Parameter(defaultValue="false")
protected String incrementVersionAfterRun

If true, add line with auto-incremented version after changelog generation

filters

public static final List<MessageFilter> filters

transformers

public static final List<MessageTransformer> transformers

Constructor Detail

ChangelogMojo

public ChangelogMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getChangelogConfiguration

public ChangelogConfiguration getChangelogConfiguration()