confluence-reporting-maven-plugin-4.5 - deploy

confluence-reporting:deploy

Generate Project's documentation in confluence's wiki format and deploy it

Mojo Attributes

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name Type Description
checkoutDirectoryName String The directory name to checkout right after the scm url Default value is ${project.artifactId}
outputDirectory File No description.
spaceKey String Confluence target confluence's spaceKey

Optional Parameters

Name Type Description
anonymousConnection String The scm anonymous connection url. Default value is ${project.scm.connection}
attachmentFolder File attachment folder Default value is ${basedir}/src/site/confluence/attachments
childrenFolder File children folder Default value is ${basedir}/src/site/confluence/children
developerConnection String The scm developer connection url. Default value is ${project.scm.developerConnection}
encoding String The file encoding of the source files. Default value is ${project.build.sourceEncoding}
endPoint String Confluence end point url Default value is http://localhost:8080/rpc/xmlrpc
gitLogCalculateRuleForSinceTagName CalculateRuleForSinceTagName If specified, plugin will try to calculate and replace actual gitLogSinceTagName value
based on current project version ${project.version} and provided rule.
Possible values are
<ul>
<li>NO_RULE</li>
<li>CURRENT_MAJOR_VERSION</li>
<li>CURRENT_MINOR_VERSION</li>
<li>LATEST_RELEASE_VERSION</li>
</ul> Default value is NO_RULE
gitLogGroupByVersions Boolean Enable grouping by versions tag Default value is false
gitLogJiraIssuesEnable Boolean Set to true for enabling substitution of ${gitlog.jiraIssues} build-in variable Default value is false
gitLogJiraProjectKeyList List Specify JIRA projects key to extract issues from gitlog
By default it will try extract all strings that match pattern (A-Za-z+)-\d+
gitLogSinceTagName String Parse git log commits since last occurrence of specified tag name
gitLogTagNamesPattern String The pattern to filter out tagName. Can be used for filter only version tags.
gitLogUntilTagName String Parse git log commits until first occurrence of specified tag name
labels List Labels to add
parentPageTitle String Confluence target confluence's spaceKey Default value is Home
password String Confluence password
properties Map additional properties pass to template processor
removeSnapshots boolean During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed Default value is false
serverId String Issue 39
Server's id in settings.xml to look up username and password.
Defaults to ${url} if not given.
siteDescriptor File site xml descriptor Default value is ${basedir}/src/site/confluence/site.xml
sslCertificate SSLCertificateInfo if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
&lt;sslCertificate>
 &lt;ignore>true|false</ignore>  // default true
 &lt;hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
 &lt;trustManagerClass>FQN</trustManagerClass> // default null
&lt;/sslCertificate>
templateWiki File Home page template source. Template name will be used also as template source for children Default value is ${basedir}/src/site/confluence/template.wiki
title String Confluence Page Title
username String Confluence username
webAccessUrl String The scm web access url. Default value is ${project.scm.url}
wikiFilesExt String Children files extension Default value is .wiki

Parameter Details

anonymousConnection

The scm anonymous connection url.

Type java.lang.String
Required No
Default ${project.scm.connection}
attachmentFolder

attachment folder

Type java.io.File
Required No
Default ${basedir}/src/site/confluence/attachments
checkoutDirectoryName

The directory name to checkout right after the scm url

Type java.lang.String
Required Yes
Default ${project.artifactId}
childrenFolder

children folder

Type java.io.File
Required No
Default ${basedir}/src/site/confluence/children
developerConnection

The scm developer connection url.

Type java.lang.String
Required No
Default ${project.scm.developerConnection}
encoding

The file encoding of the source files.

Type java.lang.String
Required No
Expression ${encoding}
Default ${project.build.sourceEncoding}
endPoint

Confluence end point url

Type java.lang.String
Required No
Expression ${confluence.endPoint}
Default http://localhost:8080/rpc/xmlrpc
gitLogCalculateRuleForSinceTagName

If specified, plugin will try to calculate and replace actual gitLogSinceTagName value
based on current project version ${project.version} and provided rule.
Possible values are
<ul>
<li>NO_RULE</li>
<li>CURRENT_MAJOR_VERSION</li>
<li>CURRENT_MINOR_VERSION</li>
<li>LATEST_RELEASE_VERSION</li>
</ul>

Type com.github.qwazer.mavenplugins.gitlog.CalculateRuleForSinceTagName
Since 4.2
Required No
Default NO_RULE
gitLogGroupByVersions

Enable grouping by versions tag

Type java.lang.Boolean
Since 4.2
Required No
Default false
gitLogJiraIssuesEnable

Set to true for enabling substitution of ${gitlog.jiraIssues} build-in variable

Type java.lang.Boolean
Since 4.2
Required No
Default false
gitLogJiraProjectKeyList

Specify JIRA projects key to extract issues from gitlog
By default it will try extract all strings that match pattern (A-Za-z+)-\d+

Type java.util.List
Since 4.2
Required No
gitLogSinceTagName

Parse git log commits since last occurrence of specified tag name

Type java.lang.String
Since 4.2
Required No
gitLogTagNamesPattern

The pattern to filter out tagName. Can be used for filter only version tags.

Type java.lang.String
Since 4.2
Required No
gitLogUntilTagName

Parse git log commits until first occurrence of specified tag name

Type java.lang.String
Since 4.2
Required No
labels

Labels to add

Type java.util.List
Required No
outputDirectory

No Description.

Type java.io.File
Required Yes
Expression ${project.build.directory/generated-site/confluence}
parentPageTitle

Confluence target confluence's spaceKey

Type java.lang.String
Required No
Expression ${confluence.parentPage}
Default Home
password

Confluence password

Type java.lang.String
Required No
Expression ${confluence.password}
properties

additional properties pass to template processor

Type java.util.Map
Required No
removeSnapshots

During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed

Type boolean
Required No
Expression ${confluence.removeSnapshots}
Default false
serverId

Issue 39

Server's id in settings.xml to look up username and password.
Defaults to ${url} if not given.

Type java.lang.String
Since 3.1.1
Required No
Expression ${confluence.serverId}
siteDescriptor

site xml descriptor

Type java.io.File
Since 3.3.0
Required No
Default ${basedir}/src/site/confluence/site.xml
spaceKey

Confluence target confluence's spaceKey

Type java.lang.String
Required Yes
Expression ${confluence.spaceKey}
sslCertificate

if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).

Below the Template

&lt;sslCertificate>
 &lt;ignore>true|false</ignore>  // default true
 &lt;hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
 &lt;trustManagerClass>FQN</trustManagerClass> // default null
&lt;/sslCertificate>

Type org.bsc.ssl.SSLCertificateInfo
Since 4.1.0
Required No
templateWiki

Home page template source. Template name will be used also as template source for children

Type java.io.File
Required No
Default ${basedir}/src/site/confluence/template.wiki
title

Confluence Page Title

Type java.lang.String
Since 3.1.3
Required No
Expression ${project.build.finalName}
username

Confluence username

Type java.lang.String
Required No
Expression ${confluence.userName}
webAccessUrl

The scm web access url.

Type java.lang.String
Required No
Default ${project.scm.url}
wikiFilesExt

Children files extension

Type java.lang.String
Since 3.2.1
Required No
Expression ${wikiFilesExt}
Default .wiki
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.