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 Regexp 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
protected String	lastTag Predefined git tag which is used for comparing.
protected String	lastTagFormat Defines format (for java String.format(lastTagFormat, lastTagPattern)) which is be used to customize git tag if differs from lastTagPattern
protected String	lastTagPattern Regexp pattern which is be used to match line with latest release version (tag).
protected String	pathToChangelog Path to changelog file
protected String	unreleasedRowPattern Regexp 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()

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

Regexp pattern which is be 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 be used to customize git tag if differs from lastTagPattern

applicableCommitPattern

@Parameter(required=true)
protected String applicableCommitPattern

Regexp pattern which is used to filter unwanted commits, i.e. only commits which match this regexp 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

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

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