Full name:
org.apache.maven.plugins:maven-changes-plugin:2.4:announcement-generate
Description:
Attributes:
test
.2.0-beta-2
.Name | Type | Since | Description |
---|---|---|---|
basedir | String |
2.1 |
The current project base directory. |
developmentTeam | String |
2.0-beta-2 |
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.0-beta-2 |
The name of the artifact to be used in the announcement. Default value is: ${project.build.finalName} . |
generateJiraAnnouncement | boolean |
2.0-beta-2 |
Deprecated. Since version 2.4 this parameter has been deprecated. Please use
the issueManagementSystems parameter instead. Default value is: false . |
maxEntries | int |
2.0-beta-2 |
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.0-beta-2 |
Directory where the template file will be generated. |
template | String |
2.0-beta-2 |
The Velocity template used to format the announcement. Default value is: announcement.vm . |
templateDirectory | String |
2.0-beta-2 |
Directory that contains the template.
Note: This directory must be a subdirectory of
Default value is: org/apache/maven/plugin/announcement . |
version | String |
2.0-beta-2 |
Version of the artifact. Default value is: ${project.version} . |
xmlPath | File |
2.0-beta-2 |
The path of the changes.xml file. |
Name | Type | Since | Description |
---|---|---|---|
announceParameters | Map |
2.1 |
Map of custom parameters for the announcement. This Map will be
passed to the template. |
announcementFile | String |
2.4 |
The name of the file which will contain the generated announcement.
If no value is specified the plugin will use the name of the
template. |
filter | String |
2.4 |
Defines the filter parameters to restrict which issues are
retrieved from JIRA. The filter parameter uses the same format of
url parameters that is used in a JIRA search. |
introduction | String |
2.0-beta-2 |
Short description or introduction of the released artifact. This
parameter will be passed to the template. Default value is: ${project.description} . |
issueManagementSystems | List |
2.4 |
A list of issue management systems to fetch releases from. This
parameter replaces the parameters
generateJiraAnnouncement and jiraMerge .
Valid values are: |
jiraMerge | boolean |
2.1 |
Deprecated. Since version 2.4 this parameter has been deprecated. Please use
the issueManagementSystems parameter instead. 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.0-beta-2 |
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.0-beta-2 |
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} . |
tracPassword | String |
2.4 |
Defines the Trac password for authentication into a private Trac
installation. |
tracQuery | String |
2.4 |
Defines the Trac query for searching for tickets. Default value is: order=id . |
tracUser | String |
2.4 |
Defines the Trac username for authentication into a private Trac
installation. |
url | String |
2.0-beta-2 |
Distribution URL of the artifact. This parameter will be passed to
the template. |
urlDownload | String |
2.0-beta-2 |
URL where the artifact can be downloaded. If not specified, no URL
is used. This parameter will be passed to the template. |
webPassword | String |
2.4 |
Defines the http password for basic authentication into the JIRA
webserver. |
webUser | String |
2.4 |
Defines the http user for basic authentication into the JIRA
webserver. |
java.util.Map
2.1
No
java.lang.String
2.4
No
${changes.announcementFile}
java.lang.String
2.1
Yes
${basedir}
java.lang.String
2.0-beta-2
Yes
${changes.developmentTeam}
${project.name} team
java.lang.String
2.4
No
java.lang.String
2.0-beta-2
Yes
${changes.finalName}
${project.build.finalName}
boolean
2.0-beta-2
Yes
${generateJiraAnnouncement}
false
java.lang.String
2.0-beta-2
No
${project.description}
generateJiraAnnouncement
and jiraMerge
.
Valid values are: changes.xml
and
JIRA
.
java.util.List
2.4
No
boolean
2.1
No
${changes.jiraMerge}
false
java.lang.String
2.1
No
${changes.jiraPassword}
java.lang.String
2.1
No
${changes.jiraUser}
Note: In versions 2.0-beta-3 and earlier this parameter was called "nbEntries".
int
2.0-beta-2
Yes
${changes.maxEntries}
25
java.io.File
2.0-beta-2
Yes
${project.build.directory}/announcement
Note: In versions 2.0-beta-3 and earlier this parameter was called "resolutionId".
java.lang.String
2.0-beta-2
No
${changes.resolutionIds}
Fixed
boolean
2.3
No
${announcement.runOnlyAtExecutionRoot}
false
Note: In versions 2.0-beta-3 and earlier this parameter was called "statusId".
java.lang.String
2.0-beta-2
No
${changes.statusIds}
Closed
java.lang.String
2.0-beta-2
Yes
${changes.template}
announcement.vm
Note: This directory must be a subdirectory of
/src/main/resources/ or current project base
directory
.
java.lang.String
2.0-beta-2
Yes
${changes.templateDirectory}
org/apache/maven/plugin/announcement
java.lang.String
2.1
No
${changes.templateEncoding}
${project.build.sourceEncoding}
java.lang.String
2.4
No
${changes.tracPassword}
java.lang.String
2.4
No
order=id
java.lang.String
2.4
No
${changes.tracUser}
url:
java.lang.String
2.0-beta-2
No
${project.url}
java.lang.String
2.0-beta-2
No
java.lang.String
2.0-beta-2
Yes
${changes.version}
${project.version}
java.lang.String
2.4
No
java.lang.String
2.4
No
java.io.File
2.0-beta-2
Yes
${basedir}/src/changes/changes.xml