Atlassian Tools

A comprehensive suite of Java tools and libraries designed to streamline integration with Atlassian Confluence. This project provides a robust REST API client, a powerful HTML publishing utility, and a Maven plugin to automate your documentation workflow.

Project Modules

This multi-module Maven project consists of the following components:

1. wiki-client

Confluence REST API Client A strongly-typed, auto-generated Java client for the Confluence Cloud REST API (v2).

• Package: net.atlassian.wiki.rest
• Features:
  • Full coverage of Confluence V2 API.
  • Specialized support for attachment management (V1 API).
  • Built with Java 21 and Jakarta EE.
  • Powered by Apache HttpClient 5.

2. wiki-publisher

HTML to Confluence Publisher A utility library that parses local documentation (HTML/Antora) and publishes it to Confluence.

• Features:
  • Parses HTML structures (optimized for Antora).
  • Transforms content into Confluence Storage Format.
  • Preserves page hierarchy and structure.
  • Handles attachments and images.

3. atlassian-maven-plugin

Maven Integration A Maven plugin that brings the power of the wiki-publisher directly into your build lifecycle.

• Goal: atlassian:publish
• Features:
  • Automate documentation publishing as part of mvn site or mvn deploy.
  • Flexible configuration for mapping local directories to Confluence spaces.
  • Secure credential management via Maven settings.xml.

4. arc42-sample

A sample project demonstrating how to use the atlassian-maven-plugin with an arc42 documentation template.

Requirements

• Java: JDK 21 or later
• Maven: 3.9 or later

Installation & Usage

All artifacts are available via Maven.

Using the Client Library

Add the dependency to your project:

<dependency>
    <groupId>io.github.huber-and.atlassian</groupId>
    <artifactId>wiki-client</artifactId>
    <version>${atlassian-tools.version}</version>
</dependency>

Using the Publisher Library

<dependency>
    <groupId>io.github.huber-and.atlassian</groupId>
    <artifactId>wiki-publisher</artifactId>
    <version>${atlassian-tools.version}</version>
</dependency>

Using the Maven Plugin

Configure the plugin in your pom.xml:

<build>
    <plugins>
        <plugin>
            <groupId>io.github.huber-and.atlassian</groupId>
            <artifactId>atlassian-maven-plugin</artifactId>
            <version>${atlassian-tools.version}</version>
            <configuration>
                <url>https://your-domain.atlassian.net/wiki</url>
                <mappers>
                    <mapper>
                        <spaceKey>DOCS</spaceKey>
                        <path>src/docs/site</path>
                    </mapper>
                </mappers>
            </configuration>
        </plugin>
    </plugins>
</build>

Building from Source

To build the entire project locally:

mvn clean install

To build a specific module:

mvn -pl wiki-client clean install

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.