org.nuiton.jredmine.plugin

Class GenerateChangelogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.GenerateChangelogMojo

All Implemented Interfaces:

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

@Mojo(name="generate-changelog")
public class GenerateChangelogMojo
extends org.nuiton.plugin.AbstractPlugin

To generate a changelog.txt file from the changes.xml file. Created on 12/09/16.

Since:

1.9

Author:

Tony Chemit - chemit@codelutin.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	attach A flag to attach the generated changelog file (with changelog classifier).
protected boolean	generateOnce A flag to generate only once in a multi-module project.
protected File	outputFile Where to generate the changelog file.
protected org.apache.maven.project.MavenProject	project Current project.
protected boolean	runOnlyOnRoot A flag to restrict only to run on root module.
protected org.apache.maven.execution.MavenSession	session Maven session.
protected boolean	skipGenerateChangelog A flag to skip the goal.
protected boolean	verbose Flag to activate verbose mode.
protected File	xmlPath The path of the changes.xml file that will be converted into the changelog.txt.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateChangelogMojo()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSkip()
protected void	doAction()
org.apache.maven.project.MavenProject	getProject()
protected void	init()
boolean	isVerbose()
void	setProject(org.apache.maven.project.MavenProject project)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkEncoding, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, needInvoke, needInvoke, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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

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

getLog, setLog

Field Detail

xmlPath

@Parameter(property="redmine.xmlPath",
           defaultValue="${basedir}/src/changes/changes.xml",
           required=true)
protected File xmlPath

The path of the changes.xml file that will be converted into the changelog.txt.

outputFile

@Parameter(property="redmine.outputFile",
           defaultValue="${project.build.directory}/changelog.txt",
           required=true)
protected File outputFile

Where to generate the changelog file.

verbose

@Parameter(property="redmine.verbose",
           defaultValue="${maven.verbose}")
protected boolean verbose

Flag to activate verbose mode.

attach

@Parameter(property="redmine.attach")
protected boolean attach

A flag to attach the generated changelog file (with changelog classifier).

skipGenerateChangelog

@Parameter(property="redmine.skipGenerateChangelog")
protected boolean skipGenerateChangelog

A flag to skip the goal.

generateOnce

@Parameter(property="redmine.generateOnce",
           defaultValue="true")
protected boolean generateOnce

A flag to generate only once in a multi-module project. The changelog.txt file will be generated only once.

runOnlyOnRoot

@Parameter(property="redmine.runOnlyOnRoot",
           defaultValue="true")
protected boolean runOnlyOnRoot

A flag to restrict only to run on root module.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Current project.

session

@Parameter(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

Maven session.

Constructor Detail

GenerateChangelogMojo

public GenerateChangelogMojo()

Method Detail

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class org.nuiton.plugin.AbstractPlugin

init

protected void init()
             throws Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

doAction

protected void doAction()
                 throws Exception

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

getProject

public org.apache.maven.project.MavenProject getProject()

setProject

public void setProject(org.apache.maven.project.MavenProject project)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)