org.nuiton.jredmine.plugin

Class GenerateChangesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.AbstractRedmineMojo

org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProjectAndVersion

org.nuiton.jredmine.plugin.GenerateChangesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, RedmineClientConfiguration, IssueCollectorConfiguration, RedmineProjectAware, RedmineVersionAware, SkipOrRunOnlyOnceAware, RedmineServiceConfiguration, org.nuiton.plugin.Plugin

@Mojo(name="generate-changes",
      requiresOnline=true,
      requiresProject=true)
public class GenerateChangesMojo
extends AbstractRedmineMojoWithProjectAndVersion
implements IssueCollectorConfiguration, SkipOrRunOnlyOnceAware

Generates the changes.xml file from the Redmine's server to be used by the maven-changes-plugin to generates the release report and send the annoncement mail at a release time.

Since:

1.0.0

Author:

tchemit

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 String	actionMapping The action mapping to the redmine tracker ids.
protected boolean	anonymous Flag to know if anonymous connexion to redmine server is required.
protected String	categoryIds The comma separated list of category ids to include in the changes.xml Note : If a value is set to empty - that means to include all categories.
protected String	changesTitle The changes file title.
protected Map<String,String>	filters
protected boolean	generateOnce A flag to generate only once in a multi-module project.
protected String	issueLinkTemplate Template strings per system that is used to discover the URL to use to display an issue report.
protected boolean	onlyCurrentVersion If you only want to show issues for the current version in the report.
protected String	releaseDescription The description of the release.
protected boolean	runOnceDone flag to mark if a runOnce goal was done
protected boolean	runOnlyOnRoot A flag to restrict only to run on root module.
protected boolean	skipGenerateChanges A flag to skip the goal.
protected String	statusIds The comma separated list of statuses ids to include in the changes.xml Note : If a value is set to empty - that means to include all status.
protected Map<Integer,String>	trackerToAction le mapping entre l'id d'un tracker et le type d'action
protected File	xmlPath The path of the changes.xml file that will be converted into an HTML report.

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProjectAndVersion

releaseVersion, versionId

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

projectId, releaseProject, releaseUser, users

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

apiKey, dateFormat, encoding, initOk, password, project, REDMINE_SYSTEM, safe, service, serviceInit, session, url, username, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateChangesMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.maven.plugins.changes.model.ChangesDocument	buildChangesDocument(Version version, User user, IssuesCollector collector)
boolean	checkRunOnceDone()
protected boolean	checkSkip()
protected void	doAction() Re-expose the protected method for test purposes...
String	getCategoryIds()
int	getMaxEntries()
String	getPriorityIds()
String	getSkipProperty()
String	getStatusIds()
String	getTrackerIds()
String	getVersionNames()
protected void	init()
boolean	isAnonymous()
boolean	isGoalSkip()
boolean	isOnlyCurrentVersion()
boolean	isRunOnce()
boolean	isRunOnceDone()
boolean	isRunOnlyOnRoot()
void	setAnonymous(boolean anonymous)

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProjectAndVersion

getProjectVersion, getProjectVersions, getVersionId, initReleaseVersion, setVersionId

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

getProjectId, initReleaseProject, initReleaseUser, setProjectId

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

afterExecute, closeService, failIfSafe, getAuthConfiguration, getEncoding, getProject, getUrl, isVerbose, setApiKey, setAuthConfiguration, setEncoding, setPassword, setProject, setUrl, setUsername, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, 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.nuiton.jredmine.plugin.IssueCollectorConfiguration

getProjectId, getVersionId, isVerbose, setVersionId

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

getLog, setLog

Field Detail

anonymous

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

Flag to know if anonymous connexion to redmine server is required.

For this goal, the default value is true

Note: If set to false, you should fill AbstractRedmineMojo.username and AbstractRedmineMojo.password properties.

Since:

1.1.3

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 an HTML report.

Since:

1.0.0

releaseDescription

@Parameter(property="releaseDescription")
protected String releaseDescription

The description of the release.

Note : if not sets - will use the redmine version description (if exists).

Since:

1.0.0

changesTitle

@Parameter(property="changesTitle",
           defaultValue="${project.description}",
           required=true)
protected String changesTitle

The changes file title.

Since:

1.0.0

onlyCurrentVersion

@Parameter(property="redmine.onlyCurrentVersion",
           defaultValue="false")
protected boolean onlyCurrentVersion

If you only want to show issues for the current version in the report. The current version being used is ${project.version} minus any "-SNAPSHOT" suffix.

Since:

1.0.0

actionMapping

@Parameter(property="redmine.actionMapping",
           required=true)
protected String actionMapping

The action mapping to the redmine tracker ids.

Possible actions are add, fix, update, remove

The syntax of mapping is action:id [,action:id]*

Example :

  fix:1
  fix:1, add:1
 

Since:

1.0.0

statusIds

@Parameter(property="redmine.statusIds")
protected String statusIds

The comma separated list of statuses ids to include in the changes.xml

Note : If a value is set to empty - that means to include all status.

Since:

1.0.0

categoryIds

@Parameter(property="redmine.categoryIds")
protected String categoryIds

The comma separated list of category ids to include in the changes.xml

Note : If a value is set to empty - that means to include all categories.

Since:

1.0.0

skipGenerateChanges

@Parameter(property="redmine.skipGenerateChanges",
           defaultValue="false")
protected boolean skipGenerateChanges

A flag to skip the goal.

Since:

1.0.0

generateOnce

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

A flag to generate only once in a multi-module project. The changes.xml file will be generated only once in the pom module and then copy in the modules.

The default behaviour is to generate once to reduce calls to redmine

Since:

1.0.0

runOnlyOnRoot

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

A flag to restrict only to run on root module.

Since:

1.6

issueLinkTemplate

@Parameter(property="redmine.issueLinkTemplate",
           defaultValue="%URL%/issues/show/%ISSUE%")
protected String issueLinkTemplate

Template strings per system that is used to discover the URL to use to display an issue report. Each key in this map denotes the (case-sensitive) identifier of the issue tracking system and its value gives the URL template.

There are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last '/' and everything that comes after it. %ISSUE%: this is the issue number.

Since:

1.7

trackerToAction

protected Map<Integer,String> trackerToAction

le mapping entre l'id d'un tracker et le type d'action

filters

protected Map<String,String> filters

runOnceDone

protected boolean runOnceDone

flag to mark if a runOnce goal was done

Constructor Detail

GenerateChangesMojo

public GenerateChangesMojo()

Method Detail

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface RedmineClientConfiguration

setAnonymous

public void setAnonymous(boolean anonymous)

Specified by:

setAnonymous in interface RedmineClientConfiguration

isOnlyCurrentVersion

public boolean isOnlyCurrentVersion()

Specified by:

isOnlyCurrentVersion in interface IssueCollectorConfiguration

getMaxEntries

public int getMaxEntries()

Specified by:

getMaxEntries in interface IssueCollectorConfiguration

getPriorityIds

public String getPriorityIds()

Specified by:

getPriorityIds in interface IssueCollectorConfiguration

getCategoryIds

public String getCategoryIds()

Specified by:

getCategoryIds in interface IssueCollectorConfiguration

getVersionNames

public String getVersionNames()

Specified by:

getVersionNames in interface IssueCollectorConfiguration

getStatusIds

public String getStatusIds()

Specified by:

getStatusIds in interface IssueCollectorConfiguration

getTrackerIds

public String getTrackerIds()

Specified by:

getTrackerIds in interface IssueCollectorConfiguration

getSkipProperty

public String getSkipProperty()

Specified by:

getSkipProperty in interface SkipOrRunOnlyOnceAware

isGoalSkip

public boolean isGoalSkip()

Specified by:

isGoalSkip in interface SkipOrRunOnlyOnceAware

isRunOnce

public boolean isRunOnce()

Specified by:

isRunOnce in interface SkipOrRunOnlyOnceAware

isRunOnlyOnRoot

public boolean isRunOnlyOnRoot()

Specified by:

isRunOnlyOnRoot in interface SkipOrRunOnlyOnceAware

isRunOnceDone

public boolean isRunOnceDone()

Specified by:

isRunOnceDone in interface SkipOrRunOnlyOnceAware

checkRunOnceDone

public boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in interface SkipOrRunOnlyOnceAware

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojoWithProjectAndVersion

Throws:

Exception

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class AbstractRedmineMojoWithProjectAndVersion

doAction

protected void doAction()
                 throws Exception

Description copied from class: AbstractRedmineMojo

Re-expose the protected method for test purposes...

Specified by:

doAction in class AbstractRedmineMojo

Throws:

Exception - if any problems

buildChangesDocument

protected org.apache.maven.plugins.changes.model.ChangesDocument buildChangesDocument(Version version,
                                                                          User user,
                                                                          IssuesCollector collector)
                                                                               throws RedmineServiceException

Throws:

RedmineServiceException