Full name:
org.apache.maven.plugins:maven-changes-plugin:2.11:announcement-generate
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| announcementDirectory | File | 2.10 | Directory where the announcement file will be generated. Default value is: ${project.build.directory}/announcement. |
| basedir | String | 2.1 | The current project base directory. User property is: basedir. |
| 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. User property is: changes.developmentTeam. |
| finalName | String | 2.0-beta-2 | The name of the artifact to be used in the announcement. Default value is: ${project.build.finalName}. User property is: changes.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. User property is: generateJiraAnnouncement. |
| 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. User property is: changes.maxEntries. |
| template | String | 2.0-beta-2 | The Velocity template used to format the announcement. Default value is: announcement.vm. User property is: changes.template. |
| templateDirectory | String | 2.0-beta-2 | 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. User property is: changes.templateDirectory. |
| version | String | 2.0-beta-2 | Version of the artifact. Default value is: ${project.version}. User property is: changes.version. |
| 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. User property is: changes.announcementFile. |
| 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. |
| githubAPIPort | int | 2.9 | The port of your github api domain. Only use if using github
enterprise. Default value is: 80. User property is: changes.githubAPIPort. |
| githubAPIScheme | String | 2.9 | The scheme of your github api domain. Only use if using github
enterprise. Default value is: http. User property is: changes.githubAPIScheme. |
| 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: changes.xml and JIRA. Note: Only one issue management system that is configured in <project>/<issueManagement> can be used. This currently means that you can combine a changes.xml file with one other issue management system. |
| issueTypes | Map | 2.6 | Maps issues types to action types for grouping issues in
announcements. If issue types are not defined for a action type
then the default issue type will be applied.
Valid action types: add, fix and update. |
| jiraConnectionTimeout | int | 2.11 | Defines the connection timeout in milliseconds when accessing
JIRA's REST-API.
Might help when you have a lot of different resolutions in your JIRA instance. Default value is: 36000. User property is: changes.jiraConnectionTimeout. |
| jiraMerge | boolean | 2.1 | Deprecated. Since version 2.4 this parameter has been deprecated. Please use
the issueManagementSystems parameter instead. Default value is: false. User property is: changes.jiraMerge. |
| jiraPassword | String | 2.1 | Defines the JIRA password for authentication into a private JIRA
installation. User property is: changes.jiraPassword. |
| jiraReceiveTimout | int | 2.11 | Defines the receive timeout in milliseconds when accessing JIRA's
REST-API.
Might help when you have a lot of different resolutions in your JIRA instance. Default value is: 32000. User property is: changes.jiraReceiveTimout. |
| jiraUser | String | 2.1 | Defines the JIRA username for authentication into a private JIRA
installation. User property is: changes.jiraUser. |
| outputDirectory | File | 2.0-beta-2 | Deprecated. Starting with version 2.10 this parameter is no longer used. You
must use announcementDirectory instead. |
| 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. User property is: changes.resolutionIds. |
| 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. User property is: announcement.runOnlyAtExecutionRoot. |
| 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. User property is: changes.statusIds. |
| templateEncoding | String | 2.1 | The template encoding. Default value is: ${project.build.sourceEncoding}. User property is: changes.templateEncoding. |
| tracPassword | String | 2.4 | Defines the Trac password for authentication into a private Trac
installation. User property is: changes.tracPassword. |
| 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. User property is: changes.tracUser. |
| url | String | 2.0-beta-2 | Distribution URL of the artifact. This parameter will be passed to
the template. User property is: project.url. |
| 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. |
| useJql | boolean | 2.10 | Use the JIRA query language instead of the JIRA query based on HTTP
parameters. From JIRA 5.1 and up only JQL is supported. JIRA 4.4
supports both JQL and URL parameter based queries. From 5.1.1 this
is obsolete, since REST queries only use JQL. Default value is: false. User property is: changes.useJql. |
| versionPrefix | String | 2.5 | The prefix used when naming versions in JIRA.
If you have a project in JIRA with several components that have different release cycles, it is an often used pattern to prefix the version with the name of the component, e.g. maven-filtering-1.0 etc. To fetch issues from JIRA for a release of the "maven-filtering" component you would need to set this parameter to "maven-filtering-". User property is: changes.versionPrefix. |
| webPassword | String | 2.4 | Defines the http password for basic authentication into the JIRA
webserver. User property is: changes.webPassword. |
| webUser | String | 2.4 | Defines the http user for basic authentication into the JIRA
webserver. User property is: changes.webUser. |
| xmlPath | File | 2.0-beta-2 | The path of the changes.xml file. Default value is: ${basedir}/src/changes/changes.xml. |
Valid values are: changes.xml and JIRA.
Note: Only one issue management system that is configured in <project>/<issueManagement> can be used. This currently means that you can combine a changes.xml file with one other issue management system.Valid action types: add, fix and update.
Might help when you have a lot of different resolutions in your JIRA instance.
Might help when you have a lot of different resolutions in your JIRA instance.
Note: In versions 2.0-beta-3 and earlier this parameter was called "nbEntries".
Note: In versions 2.0-beta-3 and earlier this parameter was called "resolutionId".
Note: In versions 2.0-beta-3 and earlier this parameter was called "statusId".
Note: This directory must be a subdirectory of /src/main/resources/ or current project base directory.
url:
If you have a project in JIRA with several components that have different release cycles, it is an often used pattern to prefix the version with the name of the component, e.g. maven-filtering-1.0 etc. To fetch issues from JIRA for a release of the "maven-filtering" component you would need to set this parameter to "maven-filtering-".