confluence-reporting:deploy

Full name:

org.bsc.maven:confluence-reporting-maven-plugin:8.0-beta1:deploy

Description:

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

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
<checkoutDirectoryName> String - The directory name to checkout right after the scm url
Default value is: ${project.artifactId}.
<outputDirectory> File - (no description)
User property is: project.build.directory/generated-site/confluence.

Optional Parameters

Name Type Since 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.
<childrenTitlesPrefixed> boolean 4.9 prefix child page with the title of the parent
Default value is: true.
User property is: confluence.childrenTitlesPrefixed.
<connectTimeoutInSeconds> long 7.0-beta2 set the confluence service socket connection timeout in seconds
Default value is: 10.
User property is: confluence.timeout.connect.secs.
<deployState> DeployStateInfo 6.0.0 Experimental feature - Store the last deployed state
If declared, a local file will be generated that keeps the last update date of all documents involved in publication.
If such file is present the plugin will check the last update date of each document, skipping it, if no update is detected.
Example: 
  <deployState>
    <active> true|false </active> <!-- default: true -->
    <outdir> target dir </outdir> <!-- default: project.build.directory -->
  </deployState>

<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}.
User property is: encoding.
<endPoint> String - Confluence api endpoint url.
  • To enable xmlrpc api procotol endpoint must end with /rpc/xmlrpc
  • To enable rest api protocol endpoint must end with /rest/api
Example: 
  
<endPoint>http://your-confluence-site/rest/api</endpoint>


Default value is: http://localhost:8080/rpc/xmlrpc.
User property is: confluence.endPoint.
<failOnError> boolean 5.0-rc1 Indicates whether the build will continue even if there are clean errors.
Default value is: true.
User property is: confluence.failOnError.
<gitLogCalculateRuleForSinceTagName> CalculateRuleForSinceTagName 4.2 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
  • NO_RULE
  • CURRENT_MAJOR_VERSION
  • CURRENT_MINOR_VERSION
  • LATEST_RELEASE_VERSION

Default value is: NO_RULE.
<gitLogGroupByVersions> Boolean 4.2 Enable grouping by versions tag
Default value is: false.
<gitLogJiraInstanceBaseUrl> URL - Sets baseurl for specific jira instance
<gitLogJiraIssuesEnable> Boolean 4.2 Set to true for enabling substitution of ${gitlog.jiraIssues} build-in variable
Default value is: false.
<gitLogJiraProjectKeyList> List 4.2 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 4.2 Parse git log commits since last occurrence of specified tag name
<gitLogTagNamesPattern> String 4.2 The pattern to filter out tagName. Can be used for filter only version tags.
<gitLogUntilTagName> String 4.2 Parse git log commits until first occurrence of specified tag name
<httpHeaders> Map - Additional HTTP headers for Confluence.
User property is: confluence.httpHeaders.
<labels> List - Labels to add
<locale> String 6.6 Overrides system locale used for content generation
<markdownProcessorInfo> MarkdownProcessorInfo 6.8 Markdown processor Info
  <markdownProcessor>
    <name>processor name</name> <-- default: pegdown -->
    <skipHtml>true | false</skipHtml> <-- default: false -->
  </markdownProcessor>

Alias is: markdownProcessor.
<pageTitle> String 3.1.3 Confluence Page Title
Default value is: ${project.build.finalName}.
User property is: confluence.page.
Alias is: title.
<parentPageId> String 4.10 Confluence parent page id. If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
User property is: confluence.parentPageId.
<parentPageTitle> String - Confluence parent page title
Default value is: Home.
User property is: confluence.parentPage.
<password> String - Confluence password
User property is: confluence.password.
<processProperties> boolean 6.6 Use this property to disable processing of properties that are in the form of URI. If true all properties in the form of URI will be resolved, downloaded and the result will be used instead
Default value is: true.
<properties> Map - additional properties pass to template processor Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
<readTimeoutInSeconds> long 7.0-beta2 set the confluence service socket read timeout in seconds
Default value is: 10.
User property is: confluence.timeout.read.secs.
<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.
User property is: confluence.removeSnapshots.
<scrollVersions> ScrollVersionsInfo 6.5-beta1 ScrollVersions addon configuration. Below the template 
<scrollVersions>
 <version>version name</version>  <!-- mandatory -->
 <skip>true|false</skip>  <!-- optional, default false (since 6.9-rc2) -->*
</scrollVersions>

<serverId> String 3.1.1 Issue 39 Server's id in settings.xml to look up username and password. Defaults to ${url} if not given.
User property is: confluence.serverId.
<siteDescriptor> File 3.3.0 site xml descriptor
Default value is: ${basedir}/src/site/confluence/site.xml.
<skip> boolean 5.1 Skip plugin execution
Default value is: false.
<spaceKey> String - Confluence target confluence spaceKey
User property is: confluence.spaceKey.
<sslCertificate> SSLCertificateInfo 4.1.0 if using a https url, configure if the plugin accepts every certifactes or respects hostnameVerifierClass and trustManagerClass (if set). Below the Template 
<sslCertificate>
 <ignore>true|false</ignore>  <!-- default: false -->
 <hostNameVerifierClass>FQN</hostnameverifierclass>  <!-- default: null -->
 <trustManagerClass>FQN</trustmanagerclass> <!-- default: null -->
</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.
<username> String - Confluence username
User property is: confluence.userName.
<webAccessUrl> String - The scm web access url.
Default value is: ${project.scm.url}.
<wikiFilesExt> String 3.2.1 Children files extension
Default value is: .wiki.
User property is: wikiFilesExt.
<writeTimeoutInSeconds> long 7.0-beta2 set the confluence service socket write timeout in seconds
Default value is: 10.
User property is: confluence.timeout.write.secs.

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

<childrenTitlesPrefixed>

prefix child page with the title of the parent
  • Type: boolean
  • Since: 4.9
  • Required: No
  • User Property: confluence.childrenTitlesPrefixed
  • Default: true

<connectTimeoutInSeconds>

set the confluence service socket connection timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.connect.secs
  • Default: 10

<deployState>

Experimental feature - Store the last deployed state
If declared, a local file will be generated that keeps the last update date of all documents involved in publication.
If such file is present the plugin will check the last update date of each document, skipping it, if no update is detected.
Example: 
  <deployState>
    <active> true|false </active> <!-- default: true -->
    <outdir> target dir </outdir> <!-- default: project.build.directory -->
  </deployState>
  • Type: org.bsc.mojo.configuration.DeployStateInfo
  • Since: 6.0.0
  • Required: No

<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
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<endPoint>

Confluence api endpoint url.
  • To enable xmlrpc api procotol endpoint must end with /rpc/xmlrpc
  • To enable rest api protocol endpoint must end with /rest/api
Example: 
  
<endPoint>http://your-confluence-site/rest/api</endpoint>

  • Type: java.lang.String
  • Required: No
  • User Property: confluence.endPoint
  • Default: http://localhost:8080/rpc/xmlrpc

<failOnError>

Indicates whether the build will continue even if there are clean errors.
  • Type: boolean
  • Since: 5.0-rc1
  • Required: No
  • User Property: confluence.failOnError
  • Default: true

<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
  • NO_RULE
  • CURRENT_MAJOR_VERSION
  • CURRENT_MINOR_VERSION
  • LATEST_RELEASE_VERSION
  • Type: org.bsc.reporting.renderer.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

<gitLogJiraInstanceBaseUrl>

Sets baseurl for specific jira instance
  • Type: java.net.URL
  • Required: No

<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

<httpHeaders>

Additional HTTP headers for Confluence.
  • Type: java.util.Map
  • Required: No
  • User Property: confluence.httpHeaders

<labels>

Labels to add
  • Type: java.util.List
  • Required: No

<locale>

Overrides system locale used for content generation
  • Type: java.lang.String
  • Since: 6.6
  • Required: No

<markdownProcessorInfo>

Markdown processor Info
  <markdownProcessor>
    <name>processor name</name> <-- default: pegdown -->
    <skipHtml>true | false</skipHtml> <-- default: false -->
  </markdownProcessor>
  • Type: org.bsc.mojo.configuration.MarkdownProcessorInfo
  • Since: 6.8
  • Required: No
  • Alias: markdownProcessor

<outputDirectory>

(no description)
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory/generated-site/confluence

<pageTitle>

Confluence Page Title
  • Type: java.lang.String
  • Since: 3.1.3
  • Required: No
  • User Property: confluence.page
  • Default: ${project.build.finalName}
  • Alias: title

<parentPageId>

Confluence parent page id. If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
  • Type: java.lang.String
  • Since: 4.10
  • Required: No
  • User Property: confluence.parentPageId

<parentPageTitle>

Confluence parent page title
  • Type: java.lang.String
  • Required: No
  • User Property: confluence.parentPage
  • Default: Home

<password>

Confluence password
  • Type: java.lang.String
  • Required: No
  • User Property: confluence.password

<processProperties>

Use this property to disable processing of properties that are in the form of URI. If true all properties in the form of URI will be resolved, downloaded and the result will be used instead
  • Type: boolean
  • Since: 6.6
  • Required: No
  • Default: true

<properties>

additional properties pass to template processor Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
  • Type: java.util.Map
  • Required: No

<readTimeoutInSeconds>

set the confluence service socket read timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.read.secs
  • Default: 10

<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
  • User Property: confluence.removeSnapshots
  • Default: false

<scrollVersions>

ScrollVersions addon configuration. Below the template 
<scrollVersions>
 <version>version name</version>  <!-- mandatory -->
 <skip>true|false</skip>  <!-- optional, default false (since 6.9-rc2) -->*
</scrollVersions>
  • Type: org.bsc.mojo.configuration.ScrollVersionsInfo
  • Since: 6.5-beta1
  • Required: No

<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
  • User Property: confluence.serverId

<siteDescriptor>

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

<skip>

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

<spaceKey>

Confluence target confluence spaceKey
  • Type: java.lang.String
  • Required: No
  • User Property: 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 
<sslCertificate>
 <ignore>true|false</ignore>  <!-- default: false -->
 <hostNameVerifierClass>FQN</hostnameverifierclass>  <!-- default: null -->
 <trustManagerClass>FQN</trustmanagerclass> <!-- default: null -->
</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

<username>

Confluence username
  • Type: java.lang.String
  • Required: No
  • User Property: 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
  • User Property: wikiFilesExt
  • Default: .wiki

<writeTimeoutInSeconds>

set the confluence service socket write timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.write.secs
  • Default: 10