Maven Confluence Plugin

Maven plugin for accessing Atlassian Confluence

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

com.github.lucapino
ArtifactId

ArtifactId

confluence-maven-plugin
Last Version

Last Version

2.0.1
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

Maven Confluence Plugin
Maven plugin for accessing Atlassian Confluence
Project URL

Project URL

https://github.com/lucapino/confluence-maven-plugin
Source Code Management

Source Code Management

https://github.com/lucapino/confluence-maven-plugin

Download confluence-maven-plugin

How to add to project

<plugin>
    <groupId>com.github.lucapino</groupId>
    <artifactId>confluence-maven-plugin</artifactId>
    <version>2.0.1</version>
</plugin>

Dependencies

compile (13)

Group / Artifact Type Version
org.apache.maven : maven-compat jar 3.5.0
org.apache.maven : maven-plugin-api jar 3.5.0
org.apache.maven : maven-artifact jar 3.5.0
org.apache.maven : maven-core jar 3.5.0
org.apache.maven : maven-settings jar 3.5.0
com.github.lucapino : confluence-rest-client jar 1.0.4
org.slf4j : slf4j-api jar 1.7.25
ch.qos.logback : logback-classic jar 1.2.3
org.apache.maven.reporting : maven-reporting-api jar 3.0
org.apache.maven.reporting : maven-reporting-impl jar 3.0.0
org.codehaus.plexus : plexus-utils jar 3.1.0
org.apache.maven.doxia : doxia-core jar 1.7
org.apache.maven.doxia : doxia-sink-api jar 1.7

provided (1)

Group / Artifact Type Version
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.5

test (3)

Group / Artifact Type Version
org.apache.maven.plugin-testing : maven-plugin-testing-harness jar 3.3.0
org.apache.maven.plugin-testing : maven-plugin-testing-tools jar 3.3.0
org.testng : testng jar 6.11

Project Modules

There are no modules declared in this project.

Maven Confluence Plugin


Maven plugin for accessing Atlassian Confluence

Plugin documentation can be found at https://lucapino.github.io/confluence-maven-plugin

Available goals:

  • add-page - adds new page (with attachments) and optionally exports it
  • add-blog-entry - adds new blog entry
  • add-comment - adds comment to existing page
  • add-attachment - adds attachment to existing page
  • export-page - exports existing page to several supported formats (pdf, doc)
  • update-page - updates existing page and optionally exports it

Example plugin definition:

<plugin>
    <groupId>it.peng.maven.plugin</groupId>
    <artifactId>confluence-maven-plugin</artifactId>
    <version>2.0.1</version>
    <configuration>
        <serverId>confluence-server</serverId>
        <url>https://confluence.example.org/confluence/ </url>
    </configuration>
</plugin>

Example add-page goal configuration:

<configuration>
    <parent>
        <space>Example Space</space>
        <title>Parent page name</title>
    </parent>
    <pageTitle>Hello world</pageTitle>
    <inputFile>${basedir}/pagetemplate.txt</inputFile>
    <outputFile>${basedir}/HelloWorld.pdf</outputFile>
    <attachments>
        <value>${basedir}/image.gif</value>
        <value>${basedir}/document.doc</value>
    </attachments>
</configuration>

Example add-blog-entry goal configuration:

<configuration>
    <space>Example space</space>
    <entryTitle>My First Post</entryTitle>
    <entryFile>${basedir}/blogentry.txt</entryFile>
</configuration>

Example add-comment goal configuration:

<configuration>
    <page>
        <space>Example space</space>
        <title>My comments</title>
    </page>
    <commentBody>${basedir}/comment.txt</commentBody>
</configuration>

Example add-attachment goal configuration:

<configuration>
    <page>
        <space>Example space</space>
        <title>My attachments</title>
    </page>
    <comment>Add attachment example</comment>
    <attachments>
        <value>${basedir}/document.pdf</value>
        <value>${basedir}/picture.png</value>
    </attachments>
</configuration>

Example export-page goal configuration:

<configuration>
    <page>
        <space>Example space</space>
        <title>My page</title>
    </page>
    <outputFile>${basedir}/MyPage.pdf</outputFile>
</configuration>

Example update-page goal configuration:

<configuration>
    <parent>
        <space>Example Space</space>
        <title>Parent page name</title>
    </parent>
    <pageTitle>Hello world</pageTitle>
    <inputFile>${basedir}/pagetemplate.txt</inputFile>
    <outputFile>${basedir}/HelloWorld.pdf</outputFile>
</configuration>

Versions

Version
2.0.1
2.0.0
1.0.0