changes:announcement-generate

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.3:announcement-generate

Description:

Goal which generate the template for an announcement.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 2.3.

Required Parameters

Name Type Since Description
basedir String 2.1 The current project base directory.
developmentTeam String 2.3 Name of the team that develops the artifact. This parameter will be passed to the template.
Default value is: ${project.name} team.
finalName String 2.3 The name of the artifact to be used in the announcement.
Default value is: ${project.build.finalName}.
generateJiraAnnouncement boolean 2.3 Flag to determine if the plugin will generate a JIRA announcement.
Default value is: false.
maxEntries int 2.3 The maximum number of issues to fetch from JIRA.

Note: In versions 2.0-beta-3 and earlier this parameter was called "nbEntries".


Default value is: 25.
outputDirectory File 2.3 Directory where the template file will be generated.
template String 2.3 The Velocity template used to format the announcement.
Default value is: announcement.vm.
templateDirectory String 2.3 Directory that contains the template.

Note: This directory must be a subdirectory of /src/main/resources/ or current project base directory.


Default value is: org/apache/maven/plugin/announcement.
version String 2.3 Version of the artifact.
Default value is: ${project.version}.
xmlPath File 2.3 The path of the changes.xml file.

Optional Parameters

Name Type Since Description
announceParameters Map 2.1 Map of custom parameters for the announcement. This Map will be passed to the template.
introduction String 2.3 Short description or introduction of the released artifact. This parameter will be passed to the template.
Default value is: ${project.description}.
jiraMerge boolean 2.1 If releases from JIRA should be merged with the releases from a changes.xml file.
Default value is: false.
jiraPassword String 2.1 Defines the JIRA password for authentication into a private JIRA installation.
jiraUser String 2.1 Defines the JIRA username for authentication into a private JIRA installation.
resolutionIds String 2.3 Include issues from JIRA with these resolution ids. Multiple resolution ids can be specified as a comma separated list of ids.

Note: In versions 2.0-beta-3 and earlier this parameter was called "resolutionId".


Default value is: Fixed.
runOnlyAtExecutionRoot boolean 2.3 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
statusIds String 2.3 Include issues from JIRA with these status ids. Multiple status ids can be specified as a comma separated list of ids.

Note: In versions 2.0-beta-3 and earlier this parameter was called "statusId".


Default value is: Closed.
templateEncoding String 2.1 The template encoding.
Default value is: ${project.build.sourceEncoding}.
url String 2.3 Distribution URL of the artifact. This parameter will be passed to the template.
urlDownload String 2.3 URL where the artifact can be downloaded. If not specified, no URL is used. This parameter will be passed to the template.

Parameter Details

announceParameters:

Map of custom parameters for the announcement. This Map will be passed to the template.
  • Type: java.util.Map
  • Since: 2.1
  • Required: No

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • Expression: ${basedir}

developmentTeam:

Name of the team that develops the artifact. This parameter will be passed to the template.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.developmentTeam}
  • Default: ${project.name} team

finalName:

The name of the artifact to be used in the announcement.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.finalName}
  • Default: ${project.build.finalName}

generateJiraAnnouncement:

Flag to determine if the plugin will generate a JIRA announcement.
  • Type: boolean
  • Since: 2.3
  • Required: Yes
  • Expression: ${generateJiraAnnouncement}
  • Default: false

introduction:

Short description or introduction of the released artifact. This parameter will be passed to the template.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Default: ${project.description}

jiraMerge:

If releases from JIRA should be merged with the releases from a changes.xml file.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${changes.jiraMerge}
  • Default: false

jiraPassword:

Defines the JIRA password for authentication into a private JIRA installation.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${changes.jiraPassword}

jiraUser:

Defines the JIRA username for authentication into a private JIRA installation.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${changes.jiraUser}

maxEntries:

The maximum number of issues to fetch from JIRA.

Note: In versions 2.0-beta-3 and earlier this parameter was called "nbEntries".

  • Type: int
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.maxEntries}
  • Default: 25

outputDirectory:

Directory where the template file will be generated.
  • Type: java.io.File
  • Since: 2.3
  • Required: Yes
  • Expression: ${project.build.directory}/announcement

resolutionIds:

Include issues from JIRA with these resolution ids. Multiple resolution ids can be specified as a comma separated list of ids.

Note: In versions 2.0-beta-3 and earlier this parameter was called "resolutionId".

  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${changes.resolutionIds}
  • Default: Fixed

runOnlyAtExecutionRoot:

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${announcement.runOnlyAtExecutionRoot}
  • Default: false

statusIds:

Include issues from JIRA with these status ids. Multiple status ids can be specified as a comma separated list of ids.

Note: In versions 2.0-beta-3 and earlier this parameter was called "statusId".

  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${changes.statusIds}
  • Default: Closed

template:

The Velocity template used to format the announcement.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.template}
  • Default: announcement.vm

templateDirectory:

Directory that contains the template.

Note: This directory must be a subdirectory of /src/main/resources/ or current project base directory.

  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.templateDirectory}
  • Default: org/apache/maven/plugin/announcement

templateEncoding:

The template encoding.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${changes.templateEncoding}
  • Default: ${project.build.sourceEncoding}

url:

Distribution URL of the artifact. This parameter will be passed to the template.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${project.url}

urlDownload:

URL where the artifact can be downloaded. If not specified, no URL is used. This parameter will be passed to the template.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No

version:

Version of the artifact.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.version}
  • Default: ${project.version}

xmlPath:

The path of the changes.xml file.
  • Type: java.io.File
  • Since: 2.3
  • Required: Yes
  • Expression: ${basedir}/src/changes/changes.xml