META-INF.README.md Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of confluence-maven-plugin Show documentation
Maven plugin for accessing Atlassian Confluence
The newest version!
Maven Confluence Plugin



Maven plugin for accessing Atlassian Confluence

[![][Build Status img]][Build Status]
[![][Coverage Status img]][Coverage Status]
[![][Dependency Status img]][Dependency Status]
[![][license img]][license]
[![][Maven Central img]][Maven Central]
[![][Javadocs img]][Javadocs]

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:
==========================
    
        it.peng.maven.plugin
        confluence-maven-plugin
        1.0.0
        
            confluence-server
            https://confluence.example.org/confluence/ 
        
    

Example _add-page_ goal configuration:
-------------------------------------
    
        
            Example Space
            Parent page name
        
        Hello world
        ${basedir}/pagetemplate.txt
        ${basedir}/HelloWorld.pdf
        
            ${basedir}/image.gif
            ${basedir}/document.doc
        
    

Example _add-blog-entry_ goal configuration:
------------------------------------------
    
        Example space
        My First Post
        ${basedir}/blogentry.txt
    

Example _add-comment_ goal configuration:
----------------------------------------
    
        
            Example space
            My comments
        
        ${basedir}/comment.txt
    

Example _add-attachment_ goal configuration:
-------------------------------------------
    
        
            Example space
            My attachments
        
        Add attachment example
        
            ${basedir}/document.pdf
            ${basedir}/picture.png
        
    

Example _export-page_ goal configuration:
----------------------------------------
    
        
            Example space
            My page
        
        ${basedir}/MyPage.pdf
    

Example _update-page_ goal configuration:
-------------------------------------
    
        
            Example Space
            Parent page name
        
        Hello world
        ${basedir}/pagetemplate.txt
        ${basedir}/HelloWorld.pdf
    

[Build Status]:https://travis-ci.org/lucapino/confluence-maven-plugin
[Build Status img]:https://travis-ci.org/lucapino/confluence-maven-plugin.svg?branch=master

[Coverage Status]:https://codecov.io/gh/lucapino/confluence-maven-plugin
[Coverage Status img]:https://codecov.io/gh/lucapino/confluence-maven-plugin/branch/master/graph/badge.svg

[Dependency Status]:https://snyk.io/test/github/lucapino/confluence-maven-plugin
[Dependency Status img]:https://snyk.io/test/github/lucapino/confluence-maven-plugin/badge.svg?style=flat

[license]:LICENSE
[license img]:https://img.shields.io/badge/license-Apache%202-blue.svg

[Maven Central]:https://maven-badges.herokuapp.com/maven-central/com.github.lucapino/confluence-maven-plugin
[Maven Central img]:https://maven-badges.herokuapp.com/maven-central/com.github.lucapino/confluence-maven-plugin/badge.svg

[Javadocs]:http://www.javadoc.io/doc/com.github.lucapino/confluence-maven-plugin
[Javadocs img]:http://javadoc.io/badge/com.github.lucapino/confluence-maven-plugin.svg