Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-changes-plugin:2.11:jira-report
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| basedir | String | 2.10 | The current project base directory. User property is: basedir. |
| Name | Type | Since | Description |
|---|---|---|---|
| columnNames | String | 2.0 | Sets the names of the columns that you want in the report. The
columns will appear in the report in the same order as you specify
them here. Multiple values can be separated by commas.
Valid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version. Default value is: Key,Summary,Status,Resolution,Assignee. |
| component | String | - | Sets the component(s) that you want to limit your report to
include. Multiple values can be separated by commas (such as
10011,10012). If this is set to empty - that means all components
will be included. |
| filter | String | - | 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. |
| fixVersionIds | String | 2.0 | Sets the fix version id(s) that you want to limit your report to
include. These are JIRA's internal version ids, NOT the
human readable display ones. Multiple fix versions can be separated
by commas. If this is set to empty - that means all fix versions
will be included. |
| forceRss | boolean | 2.9 | Since JIRA 5.1.1, it is no longer possible to construct a URL that
downloads RSS. Meanwhile JIRA added a REST API in 4.2. By default,
this plugin uses the REST API if available. Setting this parameter
to true forces it to attempt to use RSS. Default value is: false. |
| jiraDatePattern | String | 2.4 | The pattern used by dates in the JIRA XML-file. This is used to
parse the Created and Updated fields. Default value is: EEE, d MMM yyyy HH:mm:ss Z. |
| jiraPassword | String | - | Defines the JIRA password for authentication into a private JIRA
installation. |
| jiraUser | String | - | Defines the JIRA username for authentication into a private JIRA
installation. |
| maxEntries | int | - | Maximum number of entries to be fetched from JIRA. Default value is: 100. |
| onlyCurrentVersion | boolean | 2.0 | If you only want to show issues for the current version in the
report. The current version being used is
${project.version} minus any "-SNAPSHOT" suffix. Default value is: false. |
| outputDirectory | File | - | Report output directory. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output directory configured in the Maven Site
Plugin is used instead. Default value is: ${project.reporting.outputDirectory}. |
| outputEncoding | String | 2.4 | Report output encoding. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output encoding configured in the Maven Site Plugin
is used instead. Default value is: ${project.reporting.outputEncoding}. User property is: outputEncoding. |
| priorityIds | String | - | Sets the priority(s) that you want to limit your report to include.
Valid statuses are Blocker, Critical,
Major, Minor and Trivial.
Multiple values can be separated by commas. If this is set to empty
- that means all priorities will be included. |
| resolutionIds | String | - | Sets the resolution(s) that you want to fetch from JIRA. Valid
resolutions are: Unresolved, Fixed,
Won't Fix, Duplicate,
Incomplete and Cannot Reproduce. Multiple
values can be separated by commas.
Note: In versions 2.0-beta-3 and earlier this parameter had no default value. Default value is: Fixed. |
| runOnlyAtExecutionRoot | boolean | 2.10 | 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: changes.runOnlyAtExecutionRoot. |
| skip | boolean | 2.8 | If set to true, then the JIRA report will not be
generated. Default value is: false. User property is: changes.jira.skip. |
| sortColumnNames | String | 2.0 | Sets the column names that you want to sort the report by. Add
DESC following the column name to specify
descending sequence. For example Fix Version DESC,
Type sorts first by the Fix Version in descending order and
then by Type in ascending order. By default sorting is done in
ascending order, but is possible to specify ASC for
consistency. The previous example would then become Fix
Version DESC, Type ASC.
Valid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version. Note: If you are using JIRA 4 you need to put your sort column names in the reverse order. The handling of this changed between JIRA 3 and JIRA 4. The current default value is suitable for JIRA 3. This may change in the future, so please configure your sort column names in an order that works for your own JIRA version. If you use JQL, by setting the useJql parameter to true, then the order of the fields are in normal order again. Starting with JIRA 5.1 you have to use JQL. Default value is: Priority DESC, Created DESC. |
| statusIds | String | - | Sets the status(es) that you want to fetch from JIRA. Valid
statuses are: Open, In Progress,
Reopened, Resolved and
Closed. Multiple values can be separated by commas.
If your installation of JIRA uses custom status IDs, you can reference them here by their numeric values. You can obtain them on the Statuses page (in 4.0.2 it's under Administration > Issue Settings > Statuses) - just hover over the Edit link for the status you want and you'll see something like <your JIRA URL>/secure/admin/EditStatus!default.jspa?id=12345; in this case the value is 12345. Note: In versions 2.0-beta-3 and earlier this parameter had no default value. Default value is: Closed. |
| typeIds | String | 2.0 | Sets the types(s) that you want to limit your report to include.
Valid types are: Bug, New Feature,
Task, Improvement, Wish,
Test and Sub-task. Multiple values can be
separated by commas. If this is set to empty - that means all types
will be included. |
| useJql | boolean | 2.8 | 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.4 | 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-". |
| webPassword | String | - | Defines the http password for basic authentication into the JIRA
webserver. |
| webUser | String | - | Defines the http user for basic authentication into the JIRA
webserver. |
Valid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version.
Note: In versions 2.0-beta-3 and earlier this parameter had no default value.
skip:
Valid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version.
Note: If you are using JIRA 4 you need to put your sort column names in the reverse order. The handling of this changed between JIRA 3 and JIRA 4. The current default value is suitable for JIRA 3. This may change in the future, so please configure your sort column names in an order that works for your own JIRA version. If you use JQL, by setting the useJql parameter to true, then the order of the fields are in normal order again. Starting with JIRA 5.1 you have to use JQL.
If your installation of JIRA uses custom status IDs, you can reference them here by their numeric values. You can obtain them on the Statuses page (in 4.0.2 it's under Administration > Issue Settings > Statuses) - just hover over the Edit link for the status you want and you'll see something like <your JIRA URL>/secure/admin/EditStatus!default.jspa?id=12345; in this case the value is 12345.
Note: In versions 2.0-beta-3 and earlier this parameter had no default value.
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-".