org.nuiton.jredmine.plugin.announcement

Class GenerateEmailAnnouncementMojo

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.announcement.AbstractAnnouncementMojo

org.nuiton.jredmine.plugin.announcement.GenerateEmailAnnouncementMojo

All Implemented Interfaces:

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

@Mojo(name="generate-email-announcement",
      requiresOnline=true,
      requiresProject=true)
public class GenerateEmailAnnouncementMojo
extends AbstractAnnouncementMojo

Generate the content of the release email announcement.

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	emailAnnouncementTemplate The Velocity template used to format the release email announcement.
protected boolean	skipGenerateEmailAnnouncement A flag to enable or disable the goal.

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

announceParameters, anonymous, 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.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

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

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateEmailAnnouncementMojo()

Method Summary

Methods

Modifier and Type	Method and Description
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, getOutputFile, getPackaging, getProjectUrl, getUrl, getUrlDownload, init, isAnonymous, isRunOnce, setAnonymous

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

checkSkip, 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, getApiKey, getEncoding, getProject, getRestPassword, getRestUrl, getRestUsername, isRunOnceDone, isSafe, isVerbose, setApiKey, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, 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, 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

emailAnnouncementTemplate

@Parameter(property="redmine.emailAnnouncementTemplate",
           defaultValue="release-email-announcement.vm",
           required=true)
protected String emailAnnouncementTemplate

The Velocity template used to format the release email announcement.

Since:

1.0.0

skipGenerateEmailAnnouncement

@Parameter(property="changes.skipGenerateEmailAnnouncement",
           defaultValue="false")
protected boolean skipGenerateEmailAnnouncement

A flag to enable or disable the goal.

Since:

1.0.0

Constructor Detail

GenerateEmailAnnouncementMojo

public GenerateEmailAnnouncementMojo()

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