h3. {anchor:deploy}confluence-reporting:deploy
{quote}
Generate Project's documentation in confluence wiki format and deploy it
{quote}
h4. Mojo Attributes
* Requires a Maven 2.0 project to execute.
h4. Required Parameters
||Name||Type||Description||
|[checkoutDirectoryName|#checkoutDirectoryName]|String|The directory name to checkout right after the scm url Default value is $\{project.artifactId\}|
|[outputDirectory|#outputDirectory]|File|No description.|
h4. Optional Parameters
||Name||Type||Description||
|[anonymousConnection|#anonymousConnection]|String|The scm anonymous connection url. Default value is $\{project.scm.connection\}|
|[attachmentFolder|#attachmentFolder]|File|attachment folder Default value is $\{basedir\}/src/site/confluence/attachments|
|[childrenFolder|#childrenFolder]|File|children folder Default value is $\{basedir\}/src/site/confluence/children|
|[childrenTitlesPrefixed|#childrenTitlesPrefixed]|boolean|prefix child page with the title of the parent Default value is true|
|[deployState|#deployState]|DeployStateManager$Parameters|*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:
{noformat}
<deployState>
<active> true|false </active> ==> default: true
<outdir> target dir </outdir> ==> default: $\{project.build.directory\}
</deployState>
{noformat}|
|[developerConnection|#developerConnection]|String|The scm developer connection url. Default value is $\{project.scm.developerConnection\}|
|[encoding|#encoding]|String|The file encoding of the source files. Default value is $\{project.build.sourceEncoding\}|
|[endPoint|#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:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat} Default value is http://localhost:8080/rpc/xmlrpc|
|[failOnError|#failOnError]|boolean|Indicates whether the build will continue even if there are clean errors. Default value is true|
|[gitLogCalculateRuleForSinceTagName|#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
* NO\_RULE
* CURRENT\_MAJOR\_VERSION
* CURRENT\_MINOR\_VERSION
* LATEST\_RELEASE\_VERSION
Default value is NO\_RULE|
|[gitLogGroupByVersions|#gitLogGroupByVersions]|Boolean|Enable grouping by versions tag Default value is false|
|[gitLogJiraIssuesEnable|#gitLogJiraIssuesEnable]|Boolean|Set to true for enabling substitution of $\{gitlog.jiraIssues\} build-in variable Default value is false|
|[gitLogJiraProjectKeyList|#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|#gitLogSinceTagName]|String|Parse git log commits since last occurrence of specified tag name|
|[gitLogTagNamesPattern|#gitLogTagNamesPattern]|String|The pattern to filter out tagName. Can be used for filter only version tags.|
|[gitLogUntilTagName|#gitLogUntilTagName]|String|Parse git log commits until first occurrence of specified tag name|
|[labels|#labels]|List|Labels to add|
|[parentPageId|#parentPageId]|String|Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle|
|[parentPageTitle|#parentPageTitle]|String|Confluence parent page title Default value is Home|
|[password|#password]|String|Confluence password|
|[properties|#properties]|Map|additional properties pass to template processor|
|[removeSnapshots|#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|#serverId]|String|Issue 39
Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.|
|[siteDescriptor|#siteDescriptor]|File|site xml descriptor Default value is $\{basedir\}/src/site/confluence/site.xml|
|[skip|#skip]|boolean|Skip plugin execution Default value is false|
|[spaceKey|#spaceKey]|String|Confluence target confluence spaceKey|
|[sslCertificate|#sslCertificate]|SSLCertificateInfo|if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}|
|[templateWiki|#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|#title]|String|Confluence Page Title|
|[username|#username]|String|Confluence username|
|[webAccessUrl|#webAccessUrl]|String|The scm web access url. Default value is $\{project.scm.url\}|
|[wikiFilesExt|#wikiFilesExt]|String|Children files extension Default value is .wiki|
h4. Parameter Details
h5. {anchor:anonymousConnection}anonymousConnection
The scm anonymous connection url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.connection\}|
h5. {anchor:attachmentFolder}attachmentFolder
attachment folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/attachments|
h5. {anchor:checkoutDirectoryName}checkoutDirectoryName
The directory name to checkout right after the scm url
||Type|java.lang.String|
||Required|Yes|
||Default|$\{project.artifactId\}|
h5. {anchor:childrenFolder}childrenFolder
children folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/children|
h5. {anchor:childrenTitlesPrefixed}childrenTitlesPrefixed
prefix child page with the title of the parent
||Type|boolean|
||Since|4.9|
||Required|No|
||Expression|$\{confluence.childrenTitlesPrefixed\}|
||Default|true|
h5. {anchor:deployState}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:
{noformat}
<deployState>
<active> true|false </active> ==> default: true
<outdir> target dir </outdir> ==> default: $\{project.build.directory\}
</deployState>
{noformat}
||Type|org.bsc.confluence.DeployStateManager$Parameters|
||Since|6.0.0|
||Required|No|
h5. {anchor:developerConnection}developerConnection
The scm developer connection url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.developerConnection\}|
h5. {anchor:encoding}encoding
The file encoding of the source files.
||Type|java.lang.String|
||Required|No|
||Expression|$\{encoding\}|
||Default|$\{project.build.sourceEncoding\}|
h5. {anchor:endPoint}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:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat}
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.endPoint\}|
||Default|http://localhost:8080/rpc/xmlrpc|
h5. {anchor:failOnError}failOnError
Indicates whether the build will continue even if there are clean errors.
||Type|boolean|
||Since|5.0-rc1|
||Required|No|
||Expression|$\{confluence.failOnError\}|
||Default|true|
h5. {anchor:gitLogCalculateRuleForSinceTagName}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|com.github.qwazer.mavenplugins.gitlog.CalculateRuleForSinceTagName|
||Since|4.2|
||Required|No|
||Default|NO\_RULE|
h5. {anchor:gitLogGroupByVersions}gitLogGroupByVersions
Enable grouping by versions tag
||Type|java.lang.Boolean|
||Since|4.2|
||Required|No|
||Default|false|
h5. {anchor:gitLogJiraIssuesEnable}gitLogJiraIssuesEnable
Set to true for enabling substitution of $\{gitlog.jiraIssues\} build-in variable
||Type|java.lang.Boolean|
||Since|4.2|
||Required|No|
||Default|false|
h5. {anchor:gitLogJiraProjectKeyList}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|
h5. {anchor:gitLogSinceTagName}gitLogSinceTagName
Parse git log commits since last occurrence of specified tag name
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:gitLogTagNamesPattern}gitLogTagNamesPattern
The pattern to filter out tagName. Can be used for filter only version tags.
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:gitLogUntilTagName}gitLogUntilTagName
Parse git log commits until first occurrence of specified tag name
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:labels}labels
Labels to add
||Type|java.util.List|
||Required|No|
h5. {anchor:outputDirectory}outputDirectory
No Description.
||Type|java.io.File|
||Required|Yes|
||Expression|$\{project.build.directory/generated-site/confluence\}|
h5. {anchor:parentPageId}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|
||Expression|$\{confluence.parentPageId\}|
h5. {anchor:parentPageTitle}parentPageTitle
Confluence parent page title
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.parentPage\}|
||Default|Home|
h5. {anchor:password}password
Confluence password
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.password\}|
h5. {anchor:properties}properties
additional properties pass to template processor
||Type|java.util.Map|
||Required|No|
h5. {anchor:removeSnapshots}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|
h5. {anchor:serverId}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\}|
h5. {anchor:siteDescriptor}siteDescriptor
site xml descriptor
||Type|java.io.File|
||Since|3.3.0|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/site.xml|
h5. {anchor:skip}skip
Skip plugin execution
||Type|boolean|
||Since|5.1|
||Required|No|
||Default|false|
h5. {anchor:spaceKey}spaceKey
Confluence target confluence spaceKey
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.spaceKey\}|
h5. {anchor:sslCertificate}sslCertificate
if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}
||Type|org.bsc.ssl.SSLCertificateInfo|
||Since|4.1.0|
||Required|No|
h5. {anchor:templateWiki}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|
h5. {anchor:title}title
Confluence Page Title
||Type|java.lang.String|
||Since|3.1.3|
||Required|No|
||Expression|$\{project.build.finalName\}|
h5. {anchor:username}username
Confluence username
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.userName\}|
h5. {anchor:webAccessUrl}webAccessUrl
The scm web access url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.url\}|
h5. {anchor:wikiFilesExt}wikiFilesExt
Children files extension
||Type|java.lang.String|
||Since|3.2.1|
||Required|No|
||Expression|$\{wikiFilesExt\}|
||Default|.wiki|
{quote}
Generate Project's documentation in confluence wiki format and deploy it
{quote}
h4. Mojo Attributes
* Requires a Maven 2.0 project to execute.
h4. Required Parameters
||Name||Type||Description||
|[checkoutDirectoryName|#checkoutDirectoryName]|String|The directory name to checkout right after the scm url Default value is $\{project.artifactId\}|
|[outputDirectory|#outputDirectory]|File|No description.|
h4. Optional Parameters
||Name||Type||Description||
|[anonymousConnection|#anonymousConnection]|String|The scm anonymous connection url. Default value is $\{project.scm.connection\}|
|[attachmentFolder|#attachmentFolder]|File|attachment folder Default value is $\{basedir\}/src/site/confluence/attachments|
|[childrenFolder|#childrenFolder]|File|children folder Default value is $\{basedir\}/src/site/confluence/children|
|[childrenTitlesPrefixed|#childrenTitlesPrefixed]|boolean|prefix child page with the title of the parent Default value is true|
|[deployState|#deployState]|DeployStateManager$Parameters|*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:
{noformat}
<deployState>
<active> true|false </active> ==> default: true
<outdir> target dir </outdir> ==> default: $\{project.build.directory\}
</deployState>
{noformat}|
|[developerConnection|#developerConnection]|String|The scm developer connection url. Default value is $\{project.scm.developerConnection\}|
|[encoding|#encoding]|String|The file encoding of the source files. Default value is $\{project.build.sourceEncoding\}|
|[endPoint|#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:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat} Default value is http://localhost:8080/rpc/xmlrpc|
|[failOnError|#failOnError]|boolean|Indicates whether the build will continue even if there are clean errors. Default value is true|
|[gitLogCalculateRuleForSinceTagName|#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
* NO\_RULE
* CURRENT\_MAJOR\_VERSION
* CURRENT\_MINOR\_VERSION
* LATEST\_RELEASE\_VERSION
Default value is NO\_RULE|
|[gitLogGroupByVersions|#gitLogGroupByVersions]|Boolean|Enable grouping by versions tag Default value is false|
|[gitLogJiraIssuesEnable|#gitLogJiraIssuesEnable]|Boolean|Set to true for enabling substitution of $\{gitlog.jiraIssues\} build-in variable Default value is false|
|[gitLogJiraProjectKeyList|#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|#gitLogSinceTagName]|String|Parse git log commits since last occurrence of specified tag name|
|[gitLogTagNamesPattern|#gitLogTagNamesPattern]|String|The pattern to filter out tagName. Can be used for filter only version tags.|
|[gitLogUntilTagName|#gitLogUntilTagName]|String|Parse git log commits until first occurrence of specified tag name|
|[labels|#labels]|List|Labels to add|
|[parentPageId|#parentPageId]|String|Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle|
|[parentPageTitle|#parentPageTitle]|String|Confluence parent page title Default value is Home|
|[password|#password]|String|Confluence password|
|[properties|#properties]|Map|additional properties pass to template processor|
|[removeSnapshots|#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|#serverId]|String|Issue 39
Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.|
|[siteDescriptor|#siteDescriptor]|File|site xml descriptor Default value is $\{basedir\}/src/site/confluence/site.xml|
|[skip|#skip]|boolean|Skip plugin execution Default value is false|
|[spaceKey|#spaceKey]|String|Confluence target confluence spaceKey|
|[sslCertificate|#sslCertificate]|SSLCertificateInfo|if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}|
|[templateWiki|#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|#title]|String|Confluence Page Title|
|[username|#username]|String|Confluence username|
|[webAccessUrl|#webAccessUrl]|String|The scm web access url. Default value is $\{project.scm.url\}|
|[wikiFilesExt|#wikiFilesExt]|String|Children files extension Default value is .wiki|
h4. Parameter Details
h5. {anchor:anonymousConnection}anonymousConnection
The scm anonymous connection url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.connection\}|
h5. {anchor:attachmentFolder}attachmentFolder
attachment folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/attachments|
h5. {anchor:checkoutDirectoryName}checkoutDirectoryName
The directory name to checkout right after the scm url
||Type|java.lang.String|
||Required|Yes|
||Default|$\{project.artifactId\}|
h5. {anchor:childrenFolder}childrenFolder
children folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/children|
h5. {anchor:childrenTitlesPrefixed}childrenTitlesPrefixed
prefix child page with the title of the parent
||Type|boolean|
||Since|4.9|
||Required|No|
||Expression|$\{confluence.childrenTitlesPrefixed\}|
||Default|true|
h5. {anchor:deployState}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:
{noformat}
<deployState>
<active> true|false </active> ==> default: true
<outdir> target dir </outdir> ==> default: $\{project.build.directory\}
</deployState>
{noformat}
||Type|org.bsc.confluence.DeployStateManager$Parameters|
||Since|6.0.0|
||Required|No|
h5. {anchor:developerConnection}developerConnection
The scm developer connection url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.developerConnection\}|
h5. {anchor:encoding}encoding
The file encoding of the source files.
||Type|java.lang.String|
||Required|No|
||Expression|$\{encoding\}|
||Default|$\{project.build.sourceEncoding\}|
h5. {anchor:endPoint}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:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat}
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.endPoint\}|
||Default|http://localhost:8080/rpc/xmlrpc|
h5. {anchor:failOnError}failOnError
Indicates whether the build will continue even if there are clean errors.
||Type|boolean|
||Since|5.0-rc1|
||Required|No|
||Expression|$\{confluence.failOnError\}|
||Default|true|
h5. {anchor:gitLogCalculateRuleForSinceTagName}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|com.github.qwazer.mavenplugins.gitlog.CalculateRuleForSinceTagName|
||Since|4.2|
||Required|No|
||Default|NO\_RULE|
h5. {anchor:gitLogGroupByVersions}gitLogGroupByVersions
Enable grouping by versions tag
||Type|java.lang.Boolean|
||Since|4.2|
||Required|No|
||Default|false|
h5. {anchor:gitLogJiraIssuesEnable}gitLogJiraIssuesEnable
Set to true for enabling substitution of $\{gitlog.jiraIssues\} build-in variable
||Type|java.lang.Boolean|
||Since|4.2|
||Required|No|
||Default|false|
h5. {anchor:gitLogJiraProjectKeyList}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|
h5. {anchor:gitLogSinceTagName}gitLogSinceTagName
Parse git log commits since last occurrence of specified tag name
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:gitLogTagNamesPattern}gitLogTagNamesPattern
The pattern to filter out tagName. Can be used for filter only version tags.
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:gitLogUntilTagName}gitLogUntilTagName
Parse git log commits until first occurrence of specified tag name
||Type|java.lang.String|
||Since|4.2|
||Required|No|
h5. {anchor:labels}labels
Labels to add
||Type|java.util.List|
||Required|No|
h5. {anchor:outputDirectory}outputDirectory
No Description.
||Type|java.io.File|
||Required|Yes|
||Expression|$\{project.build.directory/generated-site/confluence\}|
h5. {anchor:parentPageId}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|
||Expression|$\{confluence.parentPageId\}|
h5. {anchor:parentPageTitle}parentPageTitle
Confluence parent page title
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.parentPage\}|
||Default|Home|
h5. {anchor:password}password
Confluence password
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.password\}|
h5. {anchor:properties}properties
additional properties pass to template processor
||Type|java.util.Map|
||Required|No|
h5. {anchor:removeSnapshots}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|
h5. {anchor:serverId}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\}|
h5. {anchor:siteDescriptor}siteDescriptor
site xml descriptor
||Type|java.io.File|
||Since|3.3.0|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/site.xml|
h5. {anchor:skip}skip
Skip plugin execution
||Type|boolean|
||Since|5.1|
||Required|No|
||Default|false|
h5. {anchor:spaceKey}spaceKey
Confluence target confluence spaceKey
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.spaceKey\}|
h5. {anchor:sslCertificate}sslCertificate
if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}
||Type|org.bsc.ssl.SSLCertificateInfo|
||Since|4.1.0|
||Required|No|
h5. {anchor:templateWiki}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|
h5. {anchor:title}title
Confluence Page Title
||Type|java.lang.String|
||Since|3.1.3|
||Required|No|
||Expression|$\{project.build.finalName\}|
h5. {anchor:username}username
Confluence username
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.userName\}|
h5. {anchor:webAccessUrl}webAccessUrl
The scm web access url.
||Type|java.lang.String|
||Required|No|
||Default|$\{project.scm.url\}|
h5. {anchor:wikiFilesExt}wikiFilesExt
Children files extension
||Type|java.lang.String|
||Since|3.2.1|
||Required|No|
||Expression|$\{wikiFilesExt\}|
||Default|.wiki|