jira:generate-release-notes

Full name:

com.github.lucapino:jira-maven-plugin:2.0.2:generate-release-notes

Description:

Goal that generates release notes based on a version in a JIRA project.

Attributes:

Required Parameters

Name Type Since Description
basedir String - The current project base directory.
User property is: basedir.
jiraURL String - JIRA Installation URL. If not informed, it will use the project.issueManagement.jiraURL info.
Default value is: ${project.issueManagement.url}.
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}''.
targetFile File - Target file
Default value is: ${project.build.directory}/releaseNotes.vm.
User property is: targetFile.

Optional Parameters

Name Type Since Description
afterText String - Text to be appended AFTER all issues details.
announceParameters Map - Map of custom parameters for the announcement. This Map will be passed to the template.
beforeText String - Text to be appended BEFORE all issues details.
jiraPassword String - JIRA Authentication Password.
Default value is: ${scmPassword}.
jiraProjectKey String - JIRA Project Key.
jiraUser String - JIRA Authentication User.
Default value is: ${scmUsername}.
maxIssues int - Max number of issues to return
Default value is: 100.
project MavenProject - The Maven project
Default value is: ${project}.
releaseVersion String - Released Version
Default value is: ${project.version}.
runOnlyAtExecutionRoot boolean - 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.
serverId String - Server's id in settings.xml to look up jiraUser and jiraPassword.
skip boolean - Returns if this plugin is enabled for this context
templateFile File - Template file
User property is: templateFile.

Parameter Details

afterText:

Text to be appended AFTER all issues details.
  • Type: java.lang.String
  • Required: No

announceParameters:

Map of custom parameters for the announcement. This Map will be passed to the template.
  • Type: java.util.Map
  • Required: No

basedir:

The current project base directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: basedir

beforeText:

Text to be appended BEFORE all issues details.
  • Type: java.lang.String
  • Required: No

jiraPassword:

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

jiraProjectKey:

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

jiraURL:

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

jiraUser:

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

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: No
  • Default: 100

project:

The Maven project
  • Type: org.apache.maven.project.MavenProject
  • Required: No
  • Default: ${project}

releaseVersion:

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

runOnlyAtExecutionRoot:

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.
  • Type: boolean
  • Required: No
  • Default: false

serverId:

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

skip:

Returns if this plugin is enabled for this context
  • Type: boolean
  • Required: No

targetFile:

Target file
  • Type: java.io.File
  • Required: Yes
  • User Property: targetFile
  • Default: ${project.build.directory}/releaseNotes.vm

templateFile:

Template file
  • Type: java.io.File
  • Required: No
  • User Property: templateFile

Back to top