------
 Usage
 ------
 Olivier Lamy
 ------
 2011-11-26
 ------

 ~~ Licensed to the Apache Software Foundation (ASF) under one
 ~~ or more contributor license agreements.  See the NOTICE file
 ~~ distributed with this work for additional information
 ~~ regarding copyright ownership.  The ASF licenses this file
 ~~ to you under the Apache License, Version 2.0 (the
 ~~ "License"); you may not use this file except in compliance
 ~~ with the License.  You may obtain a copy of the License at
 ~~
 ~~   http://www.apache.org/licenses/LICENSE-2.0
 ~~
 ~~ Unless required by applicable law or agreed to in writing,
 ~~ software distributed under the License is distributed on an
 ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 ~~ KIND, either express or implied.  See the License for the
 ~~ specific language governing permissions and limitations
 ~~ under the License.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html

Usage

 Some brief examples on how to use this plugin.

* Generate a diff from the project and load the issue to a new (or update) issue in your issue tracker.

  All scm supported by {{{http://maven.apache.org/scm}Apache Maven Scm}} are supported for generate a diff/patch.

  <<Note>>: The only target supported system is jira. (feature to come: reviewboard)

  Most of the parameters can be configured in the mojo or with cli (see below for easy configuration).

  <<Note>>: if you don't use non interactive mode (-B), Maven will ask you some questions.

  So hack on the project and simply use :

+---------
mvn patch-tracker:create -Dpatch.summary="foo summary" -B
// the scm declared in the pom is svn but you use git svn add the parameter
mvn patch-tracker:create -Dpatch.summary="foo summary" -B -Dscm.providerType=git
+---------

* Create an issue from a patch tracker.

  Get a patch/diff from your patch tracker system.

  <<Note>>: The only supported is github. (feature to come: reviewboard)

  So the plugin will simply read a pull request a create an issue in your issue tracker.

  <<Note>>: The only supported issue tracker is jira.

* Easy configuration setup (save your fingers!)

  By default if non using non interactive Maven mode (-B cli option), this plugin will ask you some questions.

  So you can configure some values in your pom:

+------------
<properties>
...
// id of server entry in your settings to configure user/passord for your jira instance
<patch.tracker.serverId>asf-jira</patch.tracker.serverId>

// in your setttings
<server>
  <id>asf-jira</id>
  <username>username</username>
  <password>password</password>
</server>


// configuration to read github pull requests for the project https://github.com/apache/maven-3
<patch.request.organisation>apache</patch.request.organisation>
<patch.request.repository>maven-3</patch.request.repository>

// not mandatory as it's the default value
<project.patchManagement.url>https://api.github.com</project.patchManagement.url>

...
</properties>
+------------