changes:jira-report

Note: This Mojo should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.0:jira-report

Description:

Goal which downloads issues from the Issue Tracking System and generates a report.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
outputDirectory File - Report output directory.

Optional Parameters

Name Type Since Description
columnNames String 2.0 Sets the column names that you want to show 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: Key, Summary, Status, Resolution, Assignee, Reporter, Type, Priority, Version, Fix Version and Component.

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.
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.
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.
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: Key, Summary, Status, Resolution, Assignee, Reporter, Type, Priority, Version, Fix Version, Component, Created and Updated.

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.

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

Parameter Details

columnNames :

Sets the column names that you want to show 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: Key, Summary, Status, Resolution, Assignee, Reporter, Type, Priority, Version, Fix Version and Component.

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: Key,Summary,Status,Resolution,Assignee

component :

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.

  • Type: java.lang.String
  • Required: No

filter :

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.

  • Type: java.lang.String
  • Required: No

fixVersionIds :

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.

  • Type: java.lang.String
  • Since: 2.0
  • Required: No

jiraPassword :

Defines the JIRA password for authentication into a private JIRA installation.

  • Type: java.lang.String
  • Required: No

jiraUser :

Defines the JIRA username for authentication into a private JIRA installation.

  • Type: java.lang.String
  • Required: No

maxEntries :

Maximum number of entries to be fetched from JIRA.

  • Type: int
  • Required: No
  • Default: 100

onlyCurrentVersion :

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.

  • Type: boolean
  • Since: 2.0
  • Required: No
  • Default: false

outputDirectory :

Report output directory.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

priorityIds :

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.

  • Type: java.lang.String
  • Required: No

resolutionIds :

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.

  • Type: java.lang.String
  • Required: No
  • Default: Fixed

sortColumnNames :

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: Key, Summary, Status, Resolution, Assignee, Reporter, Type, Priority, Version, Fix Version, Component, Created and Updated.

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: Priority DESC, Created DESC

statusIds :

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.

Note: In versions 2.0-beta-3 and earlier this parameter had no default value.

  • Type: java.lang.String
  • Required: No
  • Default: Closed

typeIds :

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.

  • Type: java.lang.String
  • Since: 2.0
  • Required: No

webPassword :

Defines the http password for basic authentication into the JIRA webserver.

  • Type: java.lang.String
  • Required: No

webUser :

Defines the http user for basic authentication into the JIRA webserver.

  • Type: java.lang.String
  • Required: No