Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

This is a proposed release plan for Doxia and related pieces of Maven software.

Below you will find which version of Doxia (first column) is going to be used in other software.
<table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"> Doxia </th>
<th class="confluenceTh"> Maven </th>
<th class="confluenceTh"> Maven Site Plugin </th>
<th class="confluenceTh"> maven-doxia-tools </th>
<th class="confluenceTh"> Maven PIR Plugin </th>
<th class="confluenceTh"> maven-reporting-impl </th>
</tr>
<tr>
<th class="confluenceTh"> 1.0.x </th>
<td class="confluenceTd"> 2.0.11+ </td>
<td class="confluenceTd"> 2.0.x </td>
<td class="confluenceTd"> 1.0.2+ </td>
<td class="confluenceTd"> 2.1.2+ </td>
<td class="confluenceTd"> 2.0.4.2+ </td>
</tr>
<tr>
<th class="confluenceTh"> 1.1.x </th>
<td class="confluenceTd"> 2.1.x </td>
<td class="confluenceTd"> 2.1.x </td>
<td class="confluenceTd"> 1.1.x </td>
<td class="confluenceTd"> 2.2.x </td>
<td class="confluenceTd"> 2.1.x </td>
</tr>
</tbody></table>

Any reporting plugin released with Doxia 1.0.x dependency is compatible with Doxia 1.1.x. When a reporting plugin upgrades to Doxia 1.1 to benefit from new features, it's not compatible with Doxia 1.0.x/Maven 2.0.x any more: its prerequisite section should be changed accordingly.

<h3>Actions</h3>

<table class="confluenceTable"><tbody>
<tr>
<th class="confluenceTh"> Action </th>
<th class="confluenceTh"> Developers </th>
<th class="confluenceTh"> Date completed </th>
<th class="confluenceTh"> Comments </th>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia 1.0-alpha-11, from the alpha branch </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-05-20 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use Doxia 1.0-alpha-11 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-05-20 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven PIR Plugin to use Doxia 1.0-alpha-11 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-05-20 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Move the unresolved issues slated for 2.0-beta-7 to 2.0-beta-8 or later </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-05-20 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-doxia-tools 1.0, a shared component </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2008-05-29 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use maven-doxia-tools 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-05-29 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven PIR Plugin to use maven-doxia-tools 1.0 </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2008-05-29 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-doxia-tools version 1.0.1 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-06-14 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use maven-doxia-tools 1.0.1 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-06-14 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven PIR Plugin to use maven-doxia-tools 1.0.1 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-06-14 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven Site Plugin 2.0-beta-7, to avoid having too large releases </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2008-07-02 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven PIR Plugin 2.1 </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2008-07-28 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-02-19 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use Doxia 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-02-20 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven 2.0.x to use Doxia 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-02-20 </td>
<td class="confluenceTd"> Done in 2.0.11: <a href="http://jira.codehaus.org/browse/MNG-4046">MNG-4046</a> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia-sitetools 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-01 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update maven-doxia-tools to use Doxia-sitetools 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-01 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use Doxia-sitetools 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-01 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-doxia-tools 1.0.2 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-04 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin to use maven-doxia-tools 1.0.2 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-04 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven PIR Plugin to use Doxia 1.0 </td>
<td class="confluenceTd"> hboutemy </td>
<td class="confluenceTd"> 2009-03-07 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia 1.1 </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2009-03-08 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven 2.1.x to use Doxia 1.1 </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2009-03-08 </td>
<td class="confluenceTd"> Done in 2.1.0: <a href="http://jira.codehaus.org/browse/MNG-3602">MNG-3602</a> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven Site Plugin 2.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-03-11 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia 1.1.1 </td>
<td class="confluenceTd"> ltheussl </td>
<td class="confluenceTd"> 2009-06-24 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Update Maven Site Plugin (2.1-SNAPSHOT) to use Doxia 1.1.1 </td>
<td class="confluenceTd"> ltheussl </td>
<td class="confluenceTd"> 2009-07-17 </td>
<td class="confluenceTd"> Done in <a href="http://jira.codehaus.org/browse/MSITE-298">MSITE-298</a> </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-reporting-impl 2.0.4.2 using Doxia 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-07-23 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven PIR Plugin 2.1.2 using Doxia 1.0 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-07-23 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Come up with a way to handle <a href="http://jira.codehaus.org/browse/MNG-3402">MNG-3402</a> </td>
<td class="confluenceTd"> n/a </td>
<td class="confluenceTd"> n/a </td>
<td class="confluenceTd"> Not relevant anymore. 
Doxia dep in maven 2.1/2.2  has been set to 1.1. 
Doxia dep in maven 3 has been removed. </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-doxia-tools 1.1 using Doxia 1.1.1 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-11-24 </td>
<td class="confluenceTd"> <a href="http://jira.codehaus.org/browse/MSHARED-115">MSHARED-115</a> </td>
</tr>
<tr>
<td class="confluenceTd"> Release doxia and doxia-site-tools 1.1.2 targeting issues of the <a href="http://jira.codehaus.org/browse/MSITE?report=com.atlassian.jira.plugin.system.project:roadmap-panel">site plugin</a> </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> 2009-12-07 </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven Site Plugin 2.1 using Doxia 1.1.2 </td>
<td class="confluenceTd"> dennisl </td>
<td class="confluenceTd"> 2009-12-21 </td>
<td class="confluenceTd"> <a href="http://jira.codehaus.org/browse/MSITE-419">MSITE-419</a> </td>
</tr>
<tr>
<td class="confluenceTd"> Release maven-reporting-impl 2.1 using Doxia 1.1.1 </td>
<td class="confluenceTd"> ltheussl </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Maven PIR Plugin 2.2 using Doxia 1.1.2 </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Start collecting a list of issues that blocks a Doxia 1.2 release </td>
<td class="confluenceTd"> ltheussl </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Push that list down to 0 </td>
<td class="confluenceTd"> ltheussl </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
</tr>
<tr>
<td class="confluenceTd"> Release Doxia 1.2 </td>
<td class="confluenceTd"> vsiveton </td>
<td class="confluenceTd"> </td>
<td class="confluenceTd"> </td>
</tr>
</tbody></table>

Feel free to attach your name to any of the actions above, if you are able to help with them.

<h2>sorting out Maven dependencies on Doxia</h2>

As seen in <a href="http://jira.codehaus.org/browse/MNG-3402">MNG-3402</a>, Maven distributes a doxia-sink-api copy in its uber-jar: this is the main dependency between Maven and Doxia. Every API change in doxia-sink-api needs to be included in a Maven version before it can be used in a plugin (setting this Maven's version as prerequisite).

There are other more subtle dependencies in miscellaneous parts of Maven.

<h3>Doxia: doxia-sink-api</h3>

<code>interface org.apache.maven.doxia.sink.Sink</code> (since 1.0-alpha-6, no API change until 1.0-alpha-11)

deprecated <code>interface org.codehaus.doxia.sink.Sink extends o.a.m.d.s.Sink</code> (since 1.0-alpha-7)

<code>interface org.apache.maven.doxia.sink.SinkFactory</code> (since 1.0-alpha-9)

<h3>Maven Components: reporting-api</h3>

<code>interface org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink, Locale)</code>

<code>interface org.apache.maven.reporting.MavenMultiPageReport extends MavenReport</code> (since Maven 3.0) 
<code>             #generate(org.apache.maven.doxia.sink.Sink, SinkFactory, Locale)</code>

Maven [2.0.2;2.0.7] depends on doxia-sink-api 1.0-alpha-7 
Maven 2.0.8 depends on doxia-sink-api 1.0-alpha-9 
Maven 2.0.9 depends on doxia-sink-api 1.0-alpha-10, equivalent to alpha-9 
Maven 2.0.10 depends on doxia-sink-api 1.0-alpha-11, equivalent to alpha-9

<h3>Maven Shared: reporting-impl</h3>

<code>abstract class org.apache.maven.reporting.AbstractMavenReport implements MavenReport</code> 
<code>             #generate(org.apache.maven.doxia.sink.Sink, SinkFactory, Locale)</code>

<h3>Maven Plugins: maven-site-plugin</h3>

<code>interface org.apache.maven.doxia.sink.SinkFactory</code> (same as doxia-sink-api 1.0-alpha-9, to avoid Maven 2.0.8 as a prerequisite: see <a href="http://jira.codehaus.org/browse/MSITE-368">MSITE-368</a>)

<code>interface org.apache.maven.reporting.MavenMultiPageReport extends MavenReport</code> (same as reporting-api 3.0, to avoid Maven 3.0 as a prerequisite) 
<code>             #generate(org.apache.maven.doxia.sink.Sink, SinkFactory, Locale)</code>