confluence-reporting-maven-plugin-7.0-SNAPSHOT - deploy

confluence-reporting:deploy

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

Mojo Attributes

• Requires a Maven 2.0 project to execute.

Required Parameters

Optional Parameters

  <deployState>
    <active> true|false </active> <!-- default: true -->
    <outdir> target dir </outdir> <!-- default: project.build.directory -->
  </deployState>

  <markdownProcessor>
    <name>processor name</name> <git branch!-- default: pegdown -->
  </markdownProcessor>

<scrollVersions>
 <version>version name</version>  <!-- mandatory -->
 <skip>true|false</skip>  <!-- optional, default false (since 6.9-rc2) -->\*
</scrollVersions>

<sslCertificate>
 <ignore>true|false</ignore>  <!-- default: false -->
 <hostNameVerifierClass>FQN</hostNameVerifierClass>  <!-- default: null -->
 <trustManagerClass>FQN</trustManagerClass> <!-- default: null -->
</sslCertificate>

Parameter Details

anonymousConnection

The scm anonymous connection url.

attachmentFolder

attachment folder

checkoutDirectoryName

The directory name to checkout right after the scm url

childrenFolder

children folder

childrenTitlesPrefixed

prefix child page with the title of the parent

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>

developerConnection

The scm developer connection url.

encoding

The file encoding of the source files.

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>

failOnError

Indicates whether the build will continue even if there are clean errors.

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

gitLogGroupByVersions

Enable grouping by versions tag

gitLogJiraIssuesEnable

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

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+

gitLogSinceTagName

Parse git log commits since last occurrence of specified tag name

gitLogTagNamesPattern

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

gitLogUntilTagName

Parse git log commits until first occurrence of specified tag name

labels

Labels to add

locale

Overrides system locale used for content generation

markdownProcessorInfo

Markdown processor Info

  <markdownProcessor>
    <name>processor name</name> <git branch!-- default: pegdown -->
  </markdownProcessor>

outputDirectory

No Description.

pageTitle

Confluence Page Title

parentPageId

Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle

parentPageTitle

Confluence parent page title

password

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

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

removeSnapshots

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

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>

serverId

Issue 39

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

siteDescriptor

site xml descriptor

skip

Skip plugin execution

spaceKey

Confluence target 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>

templateWiki

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

username

Confluence username

webAccessUrl

The scm web access url.

wikiFilesExt

Children files extension