org.nuiton.jredmine.plugin.announcement
Class GenerateNewsAnnouncementMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.jredmine.plugin.AbstractRedmineMojo
              org.nuiton.jredmine.plugin.announcement.AbstractAnnouncementMojo
                  org.nuiton.jredmine.plugin.announcement.GenerateNewsAnnouncementMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.io.rest.RestClientConfiguration, AnnouncementGeneratorConfiguration, org.nuiton.plugin.Plugin

public class GenerateNewsAnnouncementMojo
extends AbstractAnnouncementMojo

Generate the content of the release announcement news for Redmine.

Since:

1.0.0

Author:

tchemit

Is defined by the goal name:

generate-news-announcement

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

protected String	newsAnnouncementTemplate The Velocity template used to format the redmine announcement.
protected boolean	skipGenerateNewsAnnouncement A flag to enable or disable the goal.

Fields inherited from class org.nuiton.jredmine.plugin.announcement.AbstractAnnouncementMojo

announceParameters, artifactId, artifactsFile, artifactUrls, attachmentLinkTemplate, attachments, attachmentUrls, basedir, deploymentUrl, developmentTeam, finalName, generator, groupId, introduction, packaging, projectUrl, releases, runOnce, templateDirectory, templateEncoding, templateOutputDirectory, urlDownload, velocity, xmlPath

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

dateFormat, encoding, initOk, password, project, projectId, REDMINE_SYSTEM, releaseProject, releaseUser, releaseVersion, runOnceDone, safe, service, serviceInit, session, url, username, users, verbose, versionId

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

ROLE

Constructor Summary

GenerateNewsAnnouncementMojo()

Method Summary

protected String	getAnnouncementTemplate()
protected boolean	isGoalSkip()

Methods inherited from class org.nuiton.jredmine.plugin.announcement.AbstractAnnouncementMojo

checkRunOnceDone, doAction, getAnnounceParameters, getArtifactId, getArtifactUrls, getAttachmentLinkTemplate, getAttachmentUrls, getBasedir, getDeploymentUrl, getDevelopmentTeam, getFinalName, getGroupId, getIntroduction, getPackaging, getProjectUrl, getUrl, getUrlDownload, init, isRunOnce

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

afterExecute, checkSkip, closeService, getEncoding, getProject, getProjectId, getRestPassword, getRestUrl, getRestUsername, getVersionId, initReleaseProject, initReleaseUser, initReleaseVersion, isAnonymous, isRunOnceDone, isSafe, isVerbose, setAnonymous, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addTestResourceDir, addUrlToUrlsList, backupFile, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, 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.announcement.AnnouncementGeneratorConfiguration

getLog, getProject, getVersionId

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

getLog, setLog

Field Detail

newsAnnouncementTemplate

protected String newsAnnouncementTemplate

The Velocity template used to format the redmine announcement.

Since:

1.0.0

Is defined by:

expression:

${redmine.newsAnnouncementTemplate}

default-value:

release-news-announcement.vm

Is required.

skipGenerateNewsAnnouncement

protected boolean skipGenerateNewsAnnouncement

A flag to enable or disable the goal.

Since:

1.0.0

Is defined by:

expression:

${redmine.skipGenerateNewsAnnouncement}

default-value:

false

Constructor Detail

GenerateNewsAnnouncementMojo

public GenerateNewsAnnouncementMojo()

Method Detail

getAnnouncementTemplate

protected String getAnnouncementTemplate()

Specified by:

getAnnouncementTemplate in class AbstractAnnouncementMojo

Returns:

the name fo the template to use

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo