Apache Maven Reporting API

Clone this repo:
  1. e2d33be De-duplicate the default-method compatibility rule by Sylwester Lachiewicz · 2 days ago master
  2. b0b43f7 Remove unused test fixture fields by Sylwester Lachiewicz · 3 days ago
  3. bbebb5f Add a site index for report authors by Sylwester Lachiewicz · 4 days ago
  4. bb77c9b Use JUnit 5 assertions and Mockito best practices in tests by Sylwester Lachiewicz · 5 days ago
  5. adb1f55 Extend ATR configuration in .asf.yaml by Slawomir Jaranowski · 14 days ago

Apache Maven Reporting API

Apache License, Version 2.0, January 2004 Maven Central Reproducible Builds Verify

The contract between the Maven Site Plugin and every report plugin. A report implements MavenReport to declare its name, category and output path, and to render itself into a Doxia Sink; the site plugin calls it and decorates the result with the site skin.

Report plugins usually extend AbstractMavenReport from Maven Reporting Implementation instead of implementing this API directly.

What this is

The artifact holds four types and depends only on doxia-sink-api:

TypeRole
MavenReportThe report contract the site plugin calls
MavenReportRendererRenders one report page
MavenReportExceptionThe checked exception a report throws
MavenMultiPageReportDeprecated since 4.1.0; use MavenReport.generate(Sink, SinkFactory, Locale)

Where it sits:

doxia-sink-api
  └─ maven-reporting-api         (this repository)
       ├─ maven-reporting-impl   AbstractMavenReport, which report plugins extend
       ├─ maven-reporting-exec   finds and configures report plugins for the site
       └─ maven-site-plugin      calls MavenReport and renders the pages

New methods must be default and two defaults must never call each other — see the Javadoc or AGENTS.md Compatibility. Releases follow Doxia and come before Maven Reporting Exec, Maven Reporting Implementation and the Maven Site Plugin.

Build

mvn verify