Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

confluence-reporting:deploy

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

Mojo Attributes

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name

Type

Description

checkoutDirectoryName

String

The directory name to checkout right after the scm url Default value is ${project.artifactId}

outputDirectory

File

No description.

spaceKey

String

Confluence target confluence's spaceKey

Optional Parameters

Name

Type

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

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}

endPoint

String

Confluence end point url Default value is

http://localhost:8080/rpc/xmlrpc

labels

List

Labels to add

parentPageTitle

String

Confluence target confluence's spaceKey Default value is Home

password

String

Confluence password

properties

Map

additional properties pass to template processor

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

String

Issue 39 Server's <code>id</code> in <code>settings.xml</code> to look up username and password. Defaults to <code>${url}</code> if not given.

siteDescriptor

File

site xml descriptor Default value is ${basedir}/src/site/confluence/site.xml

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

String

Confluence Page Title

username

String

Confluence username

webAccessUrl

String

The scm web access url. Default value is ${project.scm.url}

wikiFilesExt

String

Children files extension Default value is .wiki

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

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

Expression

${encoding}

Default

${project.build.sourceEncoding}

endPoint

Confluence end point url

Type

java.lang.String

Required

No

Expression

${confluence.endPoint}

Default

http://localhost:8080/rpc/xmlrpc

labels

Labels to add

Type

java.util.List

Required

No

outputDirectory

No Description.

Type

java.io.File

Required

Yes

Expression

${project.build.directory/generated-site/confluence}

parentPageTitle

Confluence target confluence's spaceKey

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

Type

java.util.Map

Required

No

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

serverId

Issue 39

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

Type

java.lang.String

Since

3.1.1

Required

No

Expression

${confluence.serverId}

siteDescriptor

site xml descriptor

Type

java.io.File

Since

3.3.0

Required

No

Default

${basedir}/src/site/confluence/site.xml

spaceKey

Confluence target confluence's spaceKey

Type

java.lang.String

Required

Yes

Expression

${confluence.spaceKey}

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

title

Confluence Page Title

Type

java.lang.String

Since

3.1.3

Required

No

Expression

${project.build.finalName}

username

Confluence username

Type

java.lang.String

Required

No

Expression

${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

Expression

${wikiFilesExt}

Default

.wiki

  • No labels