jira:mail-release-notes

Full name:

com.github.lucapino:jira-maven-plugin:2.0.2:mail-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}.
mailContentType String - Mail content type to use.
Default value is: text/plain.
smtpHost String - Smtp Server.
smtpPort int - Port.
Default value is: 25.
subject String - Subject for the email.
Default value is: [ANNOUNCEMENT] - ${project.name} ${project.version} released.
targetFile File - Target file
Default value is: ${project.build.directory}/releaseNotes.vm.
User property is: targetFile.

Optional Parameters

Name Type Since Description
bccAddresses List - Recipient bcc email address.
fromDeveloperId String - The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
jiraPassword String - JIRA Authentication Password.
Default value is: ${scmPassword}.
jiraProjectKey String - JIRA Project Key.
jiraUser String - JIRA Authentication User.
Default value is: ${scmUsername}.
mailSender MailSender - Defines the sender of the announcement email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.
project MavenProject - The Maven project
Default value is: ${project}.
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.
senderString String - Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM. This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
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
smtpPassword String - The password used to send the email.
smtpUsername String - The username used to send the email.
sslMode boolean - If the email should be sent in SSL mode.
Default value is: false.
templateFile File - Template file
User property is: templateFile.
toAddresses List - Recipient email address.

Parameter Details

basedir:

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

bccAddresses:

Recipient bcc email address.
  • Type: java.util.List
  • Required: No

fromDeveloperId:

The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
  • 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}

mailContentType:

Mail content type to use.
  • Type: java.lang.String
  • Required: Yes
  • Default: text/plain

mailSender:

Defines the sender of the announcement email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.
  • Type: com.github.lucapino.jira.model.MailSender
  • Required: No

project:

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

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

senderString:

Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM. This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
  • Type: java.lang.String
  • Required: No

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

smtpHost:

Smtp Server.
  • Type: java.lang.String
  • Required: Yes

smtpPassword:

The password used to send the email.
  • Type: java.lang.String
  • Required: No

smtpPort:

Port.
  • Type: int
  • Required: Yes
  • Default: 25

smtpUsername:

The username used to send the email.
  • Type: java.lang.String
  • Required: No

sslMode:

If the email should be sent in SSL mode.
  • Type: boolean
  • Required: No
  • Default: false

subject:

Subject for the email.
  • Type: java.lang.String
  • Required: Yes
  • Default: [ANNOUNCEMENT] - ${project.name} ${project.version} released

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

toAddresses:

Recipient email address.
  • Type: java.util.List
  • Required: No

Back to top