confluence-maven-plugin

Create a README.md file in the root of your project and add following content:

vodafone-sms
==============

## Description

`vodafone-sms` is a library created here in ICTeam to send [SMS](http://en.wikipedia.org/wiki/Short_Message_Service)
from application deployed to Vodafone hosts.

## Tutorial

TODO

Create a folder wiki under src. Inside src/wiki create two files:

• tem.md
• nplex.md

Put the content you want in these wiki files.

In order to use the plugin you have to add these lines in your pom.xml:

    <plugin>
        <groupId>com.github.sixro</groupId>
        <artifactId>confluence-maven-plugin</artifactId>
        <version>1.0.3</version>
        <executions>
            <execution>
                <id>confluence-deploy</id>
                <goals>
                    <goal>deploy</goal>
                </goals>
                <configuration>
                    <serverId>myconfluence</serverId>
                    <endpoint>http://myconfluence:9090/rpc/xmlrpc</endpoint>
                    <spaceKey>MYSPACE</spaceKey>
                    <parentTitle>MyParent title</parentTitle>
                    <username>ConfluenceUsername</username>
                    <password>ConfluencePassword</password>
                </configuration>
            </execution>
        </executions>
    </plugin>

In the next chapter you'll have a description for every configuration parameter.

• serverId is used to look up in your ${HOME}/.m2/settings.xml for credentials to use to connect to your confluence (optional; if username and password is defined)
• endpoint is the URL of your confluence XMLRPC apis
• spaceKey is a space key found on your confluence
• parentTitle is the parent title of a page which content will be replaced by your README.md content and where all src/wiki pages will be added as children
• outputDirectory is the output directory where HTML are generated and where deploy goal load pages to deploy (optional; default values is ${project.build.directory}/confluence)
• readme is the file path of your README.md (optional; default value is README.md in the root of your project)
• wikiDirectory is the directory where to find additional wiki files (optional; default value is src/wiki)
• username is the username credential to confluence (optional; if serverId is defined)
• password is the password credential to confluence (optional; if serverId is defined)

Here you can find an example on what to add in your ${HOME}\.m2\settings.xml. As you can see we added a server with an id matching the serverId added below. Then, we configured a username and a password matching credentials of our confluence:

<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>myconfluence</id>
            <username>aUsername</username>
            <password>aPassword</password>
        </server>
    </servers>
</settings>

To get help, open an issue. In the future I hope to provide help using something else...

All contributions are welcome. The project uses a MIT License (as you can see in the root of the project). All you need to do is fork the project and send me a pull-request. Thanks!

The main reason I created this tool, is the possibility to have on my company projects the same "feeling" I have with Github projects. I would like to have a README.md in the root of my company projects and I would like to be able to read the same content on a confluence space.