This is an automated email from the ASF dual-hosted git repository. hboutemy pushed a commit to branch doc-history in repository https://gitbox.apache.org/repos/asf/maven-reporting-impl.git
commit 355e0ad52a72cd6fc1f2f6813cfe4dd1808443b4 Author: Hervé Boutemy <[email protected]> AuthorDate: Fri Dec 12 21:41:28 2025 +0900 add history since 3.0.0 --- src/site/apt/index.apt.vm | 48 +++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index cbf04a3..d568eab 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -30,49 +30,49 @@ ${project.name} Abstract classes to manage report generation, which can be run both: - * as part of a site generation, as a {{{../maven-reporting-api/}maven-reporting-api}}'s + 1. as part of a <<site generation>>, as a {{{../maven-reporting-api/}maven-reporting-api}}'s <<<{{{../maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html}MavenReport}}>>>, - * or as a direct standalone goal invocation, as a {{{/ref/current/maven-plugin-api/}maven-plugin-api}}'s + 2. or as a direct standalone <<goal invocation>>, as a {{{/ref/current/maven-plugin-api/}maven-plugin-api}}'s <<<{{{/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html}Mojo}}>>>. [] - The two APIs implementations are provided by <<<{{{./apidocs/org/apache/maven/reporting/AbstractMavenReport.html}AbstractMavenReport}}, + The two APIs implementations are provided by <<<{{{./apidocs/org/apache/maven/reporting/AbstractMavenReport.html}AbstractMavenReport}}>>>, that delegates to extender's <<<executeReport( Locale )>>> reporting method implementation. -* Usage - - A full working sample is included in <<<maven-reporting-impl>>> ITs, which are part of - {{{../scm.html}the component source tree}}: see {{{https://github.com/apache/maven-reporting-impl/tree/${project.scm.tag}/src/it/setup-reporting-plugin}<<<src/it/setup-reporting-plugin>>>}}. - -* History - ** Doxia runtime - When used as a direct standalone goal invocation, Doxia implementation used is the version used during plugin compilation. + Notice that Doxia version used at runtime varies between <<site generation>> and <<goal invocation>>: - When used as report during site generation, <<<maven-site-plugin>>> provides Doxia API implementation to the plugin, overriding + 1. when used as report during <<site generation>>, <<<maven-site-plugin>>> provides Doxia implementation to the plugin, overriding normal plugin dependency: see {{{/shared/maven-reporting-exec/xref/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.html}DefaultMavenReportExecutor}} in <<<{{{/shared/maven-reporting-exec/}maven-reporting-exec}}>>>. -** Doxia dependency + 2. when used as a direct standalone <<goal invocation>>, Doxia implementation used is the version used during plugin compilation + and kept as transitive dependency of the plugin. - From <<<maven-reporting-impl 2.1>>> to <<<maven-reporting-impl 2.3>>>, Doxia version used ranges from 1.1 to 1.4. - When creating a reporting plugin using one of these <<<maven-reporting-impl>>> versions, - take care to use corresponding <<<doxia-sink-api>>>: - - * avoid <<<doxia-sink-api>>> version 1.0 that can be imported by <<<{{{../maven-reporting-api/}maven-reporting-api}}>>> 3.0: - this would lead to <<<"java.lang.ClassNotFoundException: org.apache.maven.doxia.sink.SinkEventAttributes">>> when used as - direct standalone goal. +* Usage - * avoid <<<doxia-sink-api>>> after 1.4 since RenderingContext was moved in Doxia 1.5 from core to Site Renderer (see - {{{https://issues.apache.org/jira/browse/DOXIA-499}DOXIA-499}}). + A full working sample is included in <<<maven-reporting-impl>>> ITs, which are part of + {{{../scm.html}the component source tree}}: see {{{https://github.com/apache/maven-reporting-impl/tree/${project.scm.tag}/src/it/setup-reporting-plugin}<<<src/it/setup-reporting-plugin>>>}}. - [] +* History - <<<maven-reporting-impl 2.4.x>>> use Doxia 1.6. +*---------------*---------------------------------------------------------*---------------------* +|| release date || maven-maven-reporting-impl || {{{/doxia/}Doxia}} || +*---------------*---------------------------------------------------------*---------------------* +| 2024-10 | 4.0.0 | <<2.0.0>> +*---------------*---------------------------------------------------------*---------------------* +| 2022-08 | {{{/shared-archives/maven-reporting-impl-3.2.0/}3.2.0}} | 1.11.1 +*---------------*---------------------------------------------------------*---------------------* +| 2022-02 | {{{/shared-archives/maven-reporting-impl-3.1.0/}3.1.0}} | 1.11.1 +*---------------*---------------------------------------------------------*---------------------* +| 2017-06 | {{{/shared-archives/maven-reporting-impl-3.0.0/}3.0.0}} | 1.7 +*---------------*---------------------------------------------------------*---------------------* + +See also Maven Site Plugin's {{{/plugins/maven-site-plugin/history.html#maven-site-plugin-vs-doxia-vs-doxia-sitetools}history}}. ** Upgrading to <<<maven-reporting-impl 2.3+>>>
