org.llorllale.mvn.plgn.loggit

Class Changelog

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.llorllale.mvn.plgn.loggit.Changelog

All Implemented Interfaces:

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

@Mojo(name="changelog",
      defaultPhase=PREPARE_PACKAGE)
public final class Changelog
extends org.apache.maven.plugin.AbstractMojo

Changelog.

Since:

0.2.0

Author:

George Aristy (george.aristy@gmail.com)

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
Changelog() Ctor.
Changelog(File repo, File output) Ctor.
Changelog(File repo, File output, String format) Ctor.
Changelog(File repo, File output, String format, File customFormat) Ctor.
Changelog(File repo, File output, String format, File customFormat, String branch) Ctor.
Changelog(File repo, File output, String format, File customFormat, String branch, int maxEntries) Ctor.
Changelog(File repo, File output, String format, File customFormat, String branch, int maxEntries, String startTag) Ctor.
Changelog(File repo, File output, String format, File customFormat, String branch, int maxEntries, String startTag, String includeRegex) Ctor.
Changelog(File repo, File output, String format, File customFormat, String branch, int maxEntries, String startTag, String includeRegex, String endTag) Ctor.

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

Constructor Detail

Changelog

public Changelog()

Ctor.

Since:

0.2.0

Changelog

public Changelog(File repo,
                 File output)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

Since:

0.2.0

Changelog

public Changelog(File repo,
                 File output,
                 String format)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

Since:

0.2.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

Since:

0.2.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat,
                 String branch)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

branch - the branch to point to in order to fetch the log

Since:

0.3.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat,
                 String branch,
                 int maxEntries)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

branch - the branch to point to in order to fetch the log

maxEntries - max number of entries to include in the log

Since:

0.4.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat,
                 String branch,
                 int maxEntries,
                 String startTag)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

branch - the branch to point to in order to fetch the log

maxEntries - max number of entries to include in the log

startTag - starting tag

Since:

0.5.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat,
                 String branch,
                 int maxEntries,
                 String startTag,
                 String includeRegex)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

branch - the branch to point to in order to fetch the log

maxEntries - max number of entries to include in the log

startTag - starting tag

includeRegex - the regular expression that commit messages must match

Since:

0.6.0

Changelog

public Changelog(File repo,
                 File output,
                 String format,
                 File customFormat,
                 String branch,
                 int maxEntries,
                 String startTag,
                 String includeRegex,
                 String endTag)

Ctor.

Parameters:

repo - path to git repo

output - file to which to save the XML

format - the format for the output

customFormat - path to customFormat

branch - the branch to point to in order to fetch the log

maxEntries - max number of entries to include in the log

startTag - starting tag

includeRegex - the regular expression that commit messages must match

endTag - the ending tag

Since:

0.7.0

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