confluence-reporting-maven-plugin-7.0-SNAPSHOT - blogpost

Version 1 by Bartolomeo Sorrentino
on Dec 14, 2020 00:09.

compared with
Current by Bartolomeo Sorrentino
on Dec 14, 2020 00:09.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (2)

View page history
h3. {anchor:blogpost}confluence-reporting:blogpost
{quote}
Publish a an article to the blog
{quote}
 
h4. Mojo Attributes
* Since version: {{6.9-rc1}}

h4. Optional Parameters

||Name||Type||Description||
|[content|#content]|File|No description.|
|[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|
|[markdownProcessorInfo|#markdownProcessorInfo]|MarkdownProcessorInfo|Markdown processor Info\\
{noformat}
<markdownProcessor>
<name>processor name</name> <git branch!-- default: pegdown -->
</markdownProcessor>
{noformat}|
|[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
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties|
|[scrollVersions|#scrollVersions]|ScrollVersionsInfo|ScrollVersions addon configuration. Below the template
{noformat}
<scrollVersions>
<version>version name</version> <!-- mandatory -->
<skip>true|false</skip> <!-- optional, default false (since 6.9-rc2) -->\*
</scrollVersions>
{noformat}|
|[serverId|#serverId]|String|Issue 39
Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.|
|[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}|
|[title|#title]|String|No description.|
|[username|#username]|String|Confluence username|
|[version|#version]|int|No description. Default value is 0|
h4. Parameter Details

h5. {anchor:content}content
No Description.
||Type|java.io.File|
||Required|No|
||Expression|$\{blog.content\}|
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:markdownProcessorInfo}markdownProcessorInfo
Markdown processor Info\\
{noformat}
<markdownProcessor>
<name>processor name</name> <git branch!-- default: pegdown -->
</markdownProcessor>
{noformat}
||Type|org.bsc.mojo.configuration.MarkdownProcessorInfo|
||Since|6.8|
||Required|No|
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
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
||Type|java.util.Map|
||Required|No|
h5. {anchor:scrollVersions}scrollVersions
ScrollVersions addon configuration. Below the template

{noformat}
<scrollVersions>
<version>version name</version> <!-- mandatory -->
<skip>true|false</skip> <!-- optional, default false (since 6.9-rc2) -->\*
</scrollVersions>
{noformat}
||Type|org.bsc.mojo.configuration.ScrollVersionsInfo|
||Since|6.5-beta1|
||Required|No|
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: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:title}title
No Description.
||Type|java.lang.String|
||Required|No|
||Expression|$\{blog.title\}|
h5. {anchor:username}username
Confluence username
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.userName\}|
h5. {anchor:version}version
No Description.
||Type|int|
||Required|No|
||Expression|$\{blog.version\}|
||Default|0|