changes:announcement-generate

Full name:

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

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/.

Default value is: org/apache/maven/plugin/announcement.
url String - Distribution url of the artifact.
xmlPath File - The path of the changes.xml file.

Optional Parameters

Name Type Since Description
introduction String - Short description or introduction of the released artifact.
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.
urlDownload String - URL where the artifact can be downloaded. If not specified, no URL is used.

Parameter Details

developmentTeam :

Name of the team that develops the artifact.

  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.name} team

finalName :

The name of the artifact to be used in the announcement.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${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
  • Expression: ${project.description}

maxEntries :

The maximum number of issues to include.

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

  • Type: int
  • Required: Yes
  • 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
  • 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
  • Default: Closed

template :

The Velocity template used to format the announcement.

  • Type: java.lang.String
  • Required: Yes
  • Default: announcement.vm

templateDirectory :

Directory that contains the template.

Note: This directory must be a subdirectory of /src/main/resources/.

  • Type: java.lang.String
  • Required: Yes
  • Default: org/apache/maven/plugin/announcement

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

xmlPath :

The path of the changes.xml file.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/changes/changes.xml