changes:announcement-generate

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.1: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.

Required Parameters

Name Type Since Description
basedir String 2.1 The current project base directory.
developmentTeam String - Name of the team that develops the artifact.
Default value is: ${project.name} team.
finalName String - The name of the artifact to be used in the announcement.
Default value is: ${project.build.finalName}.
generateJiraAnnouncement boolean - Flag to determine if the plugin will generate a JIRA announcement.
Default value is: false.
maxEntries int - 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 - Directory where the template file will be generated.
template String - The Velocity template used to format the announcement.
Default value is: announcement.vm.
templateDirectory String - 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.
url String - Distribution url of the artifact.
version String - Version of the artifact.
Default value is: ${project.version}.
xmlPath File - The path of the changes.xml file.

Optional Parameters

Name Type Since Description
announceParameters Map 2.1 Map which will be pass to the velocity context
introduction String - Short description or introduction of the released artifact.
Default value is: ${project.description}.
jiraMerge boolean 2.1 The template encoding.
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 - Only fixed issues are needed.

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


Default value is: Fixed.
statusIds String - Only closed issues are needed.

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}.
urlDownload String - URL where the artifact can be downloaded. If not specified, no URL is used.

Parameter Details

announceParameters:

Map which will be pass to the velocity context
  • 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.
  • Type: java.lang.String
  • 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
  • Required: Yes
  • Expression: ${changes.finalName}
  • Default: ${project.build.finalName}

generateJiraAnnouncement:

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

introduction:

Short description or introduction of the released artifact.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.description}

jiraMerge:

The template encoding.
  • 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
  • Required: Yes
  • Expression: ${changes.maxEntries}
  • Default: 25

outputDirectory:

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

resolutionIds:

Only fixed issues are needed.

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

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

statusIds:

Only closed issues are needed.

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

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

template:

The Velocity template used to format the announcement.
  • Type: java.lang.String
  • 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
  • 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.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.url}

urlDownload:

URL where the artifact can be downloaded. If not specified, no URL is used.
  • Type: java.lang.String
  • Required: No

version:

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

xmlPath:

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