[PR] Document which Maven Site Plugin version the reports need [maven-project-info-reports-plugin]

["slachiewicz (via GitHub)" <gi...@apache.org>]

slachiewicz opened a new pull request, #649:
URL: https://github.com/apache/maven-project-info-reports-plugin/pull/649

   Addresses the documentation half of #103, the first of the two options @hboutemy laid out there.
   
   The code half is done: apache/maven-reporting-impl#243 is merged, so `AbstractMavenReportRenderer` no longer calls the Doxia 2 only `Sink.verbatim()`. But that only helps once maven-reporting-impl is released and this plugin picks it up. Every released version from 3.7.0 to 3.9.0 stays affected, and right now nothing tells a user why five of their reports are truncated.
   
   It is easy to hit without configuring anything: **Maven 3.9.x still binds Maven Site Plugin 3.12.1 by default**, which provides Doxia 1, and a report plugin renders with the Doxia the Site Plugin provides rather than its own. `DefaultMavenReportExecutor` imports the `org.apache.maven.doxia.sink` package from the Site Plugin's class realm and excludes `doxia-sink-api` from the report plugin's own dependencies, so the plugin's declared Doxia version is not what it gets. I reproduced this on Maven 3.9.16 with MPIR 3.9.0.
   
   The failure is quiet in the worst way: a `[WARNING]` per report, the report cut off part way through, and `BUILD SUCCESS`.
   
   So this adds a section to the usage page stating the requirement, naming the affected reports, quoting the warning so it is searchable, and showing how to pin the Site Plugin.
   
   The requirement is scoped to 3.7.0 through 3.9.0 rather than written as open ended, since the reporting-impl fix is meant to make later versions work with either Doxia and the wording should not outlive that.
   
   Rendered with `mvn site` to check the formatting.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Document which Maven Site Plugin version the reports need [maven-project-info-reports-plugin]

["slachiewicz (via GitHub)" <gi...@apache.org>]

slachiewicz merged PR #649:
URL: https://github.com/apache/maven-project-info-reports-plugin/pull/649


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org