confluence:update-page

Full name:

com.github.lucapino:confluence-maven-plugin:2.0.0:update-page

Description:

Updates the content of an existing page. If the user don't specify append or prepend, the new content will substitute the whole page.

Attributes:

Required Parameters

Name Type Since Description
<append> boolean - Append content to existing page.
Default value is: false.
<basedir> String - The current project base directory.
User property is: basedir.
<inputFile> File - Text file with page content
<pageTitle> String - Page title
<parent> PageDescriptor - Page's parent descriptor
<prepend> boolean - Prepend content to existing page.
Default value is: false.
<url> String - URL pointing to Confluence server, i.e:
  • https://developer.atlassian.com
  • http://www.example.org/confluence/
<wikiFormat> Boolean - Use wiki format in the template
Default value is: false.

Optional Parameters

Name Type Since Description
<announceParameters> HashMap - Map of custom parameters for the release notes. This Map will be passed to the template.
<password> String - Confluence Authentication Password.
Default value is: ${scmPassword}.
<runOnlyAtExecutionRoot> boolean - This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
<serverId> String - Server id corresponding to entry within settings.xml
<skip> boolean - Returns if this plugin is enabled for this context
Default value is: false.
<username> String - Confluence Authentication User.
Default value is: ${scmUsername}.
<verbose> boolean - (no description)
Default value is: false.

Parameter Details

<announceParameters>

Map of custom parameters for the release notes. This Map will be passed to the template.
  • Type: java.util.HashMap
  • Required: No

<append>

Append content to existing page.
  • Type: boolean
  • Required: Yes
  • Default: false

<basedir>

The current project base directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: basedir

<inputFile>

Text file with page content
  • Type: java.io.File
  • Required: Yes

<pageTitle>

Page title
  • Type: java.lang.String
  • Required: Yes

<parent>

Page's parent descriptor
  • Type: com.github.lucapino.confluence.model.PageDescriptor
  • Required: Yes

<password>

Confluence Authentication Password.
  • Type: java.lang.String
  • Required: No
  • Default: ${scmPassword}

<prepend>

Prepend content to existing page.
  • Type: boolean
  • Required: Yes
  • Default: false

<runOnlyAtExecutionRoot>

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Required: No
  • Default: false

<serverId>

Server id corresponding to entry within settings.xml
  • Type: java.lang.String
  • Required: No

<skip>

Returns if this plugin is enabled for this context
  • Type: boolean
  • Required: No
  • Default: false

<url>

URL pointing to Confluence server, i.e:
  • https://developer.atlassian.com
  • http://www.example.org/confluence/
  • Type: java.lang.String
  • Required: Yes

<username>

Confluence Authentication User.
  • Type: java.lang.String
  • Required: No
  • Default: ${scmUsername}

<verbose>

(no description)
  • Type: boolean
  • Required: No
  • Default: false

<wikiFormat>

Use wiki format in the template
  • Type: java.lang.Boolean
  • Required: Yes
  • Default: false