Skip to end of metadata
Go to start of metadata

MAVEN CONFLUENCE PLUGIN - DOCUMENTATION


VERSION 4.2


auto generated page

Icon

this page has been generated by plugin: org.bsc.maven:maven-confluence-reporting-plugin

Index

Description

plugin that document a project (using maven site style) and send result to a live confluence site http://www.atlassian.com/software/confluence/


Plugin Goals

Name

Description

confluence-reporting:help

Display help information on confluence-reporting-maven-plugin.<br/>
Call <code>mvn confluence-reporting:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.

confluence-reporting:delete

Delete a confluence pageTitle

confluence-reporting:export

Export a confluence page either in PDF or DOC

confluence-reporting:deploy

Generate Project's documentation in confluence's wiki format and deploy it


Repository

From Release 3.0.1 this plugin is available from MAVEN CENTRAL REPO
If you want stay tune over modification, includes the following repository declaration in your POM

plugin repository

Usage

Below examples of plugin declarations

Basic Declaration

Add labels

Inject custom properties within template

Change wiki files extension

Authentication

Icon

Put yours confluence credential within settings.xml as server

<server>
    <id>my_confluence_server</id>
    <username>my_user</username>
    <password>my_password</password>
</server>

Take note that also maven ecryption is supported

Use template variables

By default the plugin use an internal template to generate confluence page. You can customize the generated page creating a personal template into folder ${basedir}/src/site/confluence named template.wiki.
The template can include all valid confluence contents plus the following built-in variables

Built-In template variables

variable

description

example

${project.summary}

project summary

 

${project.scmManager}

scm information

 

${project.dependencies}

dependencies

 

${pageTitle}

title of page

confluence-reporting-maven-plugin-4.2

${artifactId}

artifactId

confluence-reporting-maven-plugin

${version}

version

4.2

${gitlog.jiraIssues}

list of JIRA issuses, extracted from gitlog since start tag

 

${gitlog.sinceTagName}

name of version tag to start extract JIRA issues

 

Git log template variables

Main idea is automated creating of release notes with list of resolved JIRA issues utilizing integration between JIRA and Confluence.
Prerequrements:

  1. Include JIRA issue key in git commit message
  2. Using git as SCM and using version tags in git

Git log configuration options

  • gitLogJiraIssuesEnable Set it to true for enabling substitution of ${gitlog.jiraIssues} build-in variable. Default value is false.
  • gitLogSinceTagName Parse git log commits since last occurrence of specified tag name.
  • gitLogUntilTagName Parse git log commits until first occurrence of specified tag name.
  • gitLogCalculateRuleForSinceTagName If specified, plugin will try to calculate and replace actual gitLogSinceTagName value based on current project version ${project.version} and provided rule. Possible values are
    • NO_RULE
    • CURRENT_MAJOR_VERSION. For example 1.2.3 will be resolved to 1.0.0
    • CURRENT_MINOR_VERSION. For example 1.2.3 will be resolved to 1.2.0
    • LATEST_RELEASE_VERSION. For example, if latest known version from version tags is 1.0.1 and current artifact (not released) version is 2.0.0, it will be resolved to 1.0.1
  • gitLogJiraProjectKeyList JIRA projects keys to extract issues from gitlog. By default it will try extract all strings that match pattern (A-Za-z+)-\d+
  • gitLogTagNamesPattern The pattern to filter out tagName. Can be used for filter only version tags
  • gitLogGroupByVersions Enable grouping by versions tag

Sample produced output of ${gitlog.jiraIssues} with gitLogGroupByVersions=true

Tips & Tricks

Icon
  • How to refer to an image

    !${pageTitle}^image_name!.

  • How to refer to an attachment

    [${pageTitle}^attachment_name].

Template example

{info:title=Useful Information}
This page has been generated by [maven-confluence-plugin|http://code.google.com/p/maven-confluence-plugin/]
{info}

{toc}

h1. Introduction

{panel}
project description
{panel}

h1. Usage

{panel}
How to use the project
{panel}

${project.summary}


${project.scmManager}


${project.dependencies}

This is the home of the maven confluence site plugin space.

To help you on your way, we've inserted some of our favourite macros on this home page. As you start creating pages, adding news items and commenting you'll see the macros below fill up with all the activity in your space.