jira:jira-report

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

Full name:

com.github.lucapino:jira-maven-plugin:2.0.2:jira-report

Description:

Creates a report of a JIRA version.

Attributes:

Required Parameters

Name Type Since Description
jiraProjectKey String - JIRA Project Key.
jqlTemplate String - JQL Template to generate release notes. Parameter 0 = Project Key Parameter 1 = Fix version
Default value is: project = ''{0}'' AND status in (Resolved, Closed) AND fixVersion = ''{1}''.
maxIssues int - Max number of issues to return
Default value is: 100.
releaseVersion String - Released Version
Default value is: ${project.version}.
jira.url String - JIRA Installation URL. If not informed, it will use the project.issueManagement.url info.
Default value is: ${project.issueManagement.url}.

Optional Parameters

Name Type Since Description
columnNames String - 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.
outputEncoding String - 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.
password String - JIRA Authentication Password.
Default value is: ${scmPassword}.
serverId String - Server's id in settings.xml to look up username and password.
skip boolean - Skip plugin execution
Default value is: false.
username String - JIRA Authentication User.
Default value is: ${scmUsername}.

Parameter Details

columnNames:

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.

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

jiraProjectKey:

JIRA Project Key.
  • Type: java.lang.String
  • Required: Yes

jqlTemplate:

JQL Template to generate release notes. Parameter 0 = Project Key Parameter 1 = Fix version
  • Type: java.lang.String
  • Required: Yes
  • Default: project = ''{0}'' AND status in (Resolved, Closed) AND fixVersion = ''{1}''

maxIssues:

Max number of issues to return
  • Type: int
  • Required: Yes
  • Default: 100

outputEncoding:

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.
  • Type: java.lang.String
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

password:

JIRA Authentication Password.
  • Type: java.lang.String
  • Required: No
  • Default: ${scmPassword}

releaseVersion:

Released Version
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.version}

serverId:

Server's id in settings.xml to look up username and password.
  • Type: java.lang.String
  • Required: No

skip:

Skip plugin execution
  • Type: boolean
  • Required: No
  • Default: false

jira.url:

JIRA Installation URL. If not informed, it will use the project.issueManagement.url info.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.issueManagement.url}

username:

JIRA Authentication User.
  • Type: java.lang.String
  • Required: No
  • Default: ${scmUsername}

Back to top