E-mail
confluence-reporting:blogpost
Publish a an article to the blog
Mojo Attributes
- Since version: 6.9-rc1
Optional Parameters
| Name | Type | Description |
|---|---|---|
| content | File | No description. |
| encoding | String | The file encoding of the source files. Default value is ${project.build.sourceEncoding} |
| endPoint | String | Confluence api endpoint url.
|
| failOnError | boolean | Indicates whether the build will continue even if there are clean errors. Default value is true |
| markdownProcessorInfo | MarkdownProcessorInfo | Markdown processor Info <markdownProcessor>
<name>processor name</name> <git branch!-- default: pegdown -->
</markdownProcessor>
|
| parentPageId | String | Confluence parent page id. If set it is possible to avoid specifying parameters spaceKey and parentPageTitle |
| parentPageTitle | String | Confluence parent page title Default value is Home |
| password | String | Confluence password |
| 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 | ScrollVersionsInfo | 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 | Issue 39 Server's id in settings.xml to look up username and password. Defaults to ${url} if not given. |
| skip | boolean | Skip plugin execution Default value is false |
| spaceKey | String | Confluence target confluence spaceKey |
| sslCertificate | SSLCertificateInfo | 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> |
| title | String | No description. |
| username | String | Confluence username |
| version | int | No description. Default value is 0 |
Parameter Details
content
No Description.
| Type | java.io.File |
|---|---|
| Required | No |
| Expression | ${blog.content} |
encoding
The file encoding of the source files.
| Type | java.lang.String |
|---|---|
| Required | No |
| Expression | ${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 |
| Expression | ${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 |
| Expression | ${confluence.failOnError} |
| Default | true |
markdownProcessorInfo
Markdown processor Info
<markdownProcessor>
<name>processor name</name> <git branch!-- default: pegdown -->
</markdownProcessor>
| Type | org.bsc.mojo.configuration.MarkdownProcessorInfo |
|---|---|
| Since | 6.8 |
| Required | No |
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} |
parentPageTitle
Confluence parent page title
| 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
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
| Type | java.util.Map |
|---|---|
| Required | No |
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 |
| Expression | ${confluence.serverId} |
skip
Skip plugin execution
| Type | boolean |
|---|---|
| Since | 5.1 |
| Required | No |
| Default | false |
spaceKey
Confluence target confluence spaceKey
| Type | java.lang.String |
|---|---|
| Required | No |
| 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
<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 |
title
No Description.
| Type | java.lang.String |
|---|---|
| Required | No |
| Expression | ${blog.title} |
username
Confluence username
| Type | java.lang.String |
|---|---|
| Required | No |
| Expression | ${confluence.userName} |
version
No Description.
| Type | int |
|---|---|
| Required | No |
| Expression | ${blog.version} |
| Default | 0 |