Skip to content

Explain why the legacy org.codehaus.doxia.sink.Sink stays - #188

Draft
slachiewicz wants to merge 1 commit into
apache:masterfrom
slachiewicz:explain-codehaus-sink
Draft

slachiewicz wants to merge 1 commit into
apache:masterfrom
slachiewicz:explain-codehaus-sink

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

org.codehaus.doxia.sink.Sink, deprecated since Doxia 1.0-alpha-6, looks like dead code, but it is load-bearing: report plugins that still declare the Maven 2 era generate(org.codehaus.doxia.sink.Sink, Locale) need it to load during mvn site. With it removed, a site build with the JaCoCo report fails:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.22.0:site (default-site) on project jacoco-site: Execution default-site of goal org.apache.maven.plugins:maven-site-plugin:3.22.0:site failed: A required class was missing while executing org.apache.maven.plugins:maven-site-plugin:3.22.0:site: org/codehaus/doxia/sink/Sink

This adds the reason to the class Javadoc and a test that references the type, so a deprecation cleanup cannot delete it unnoticed.

Verified: jacoco-maven-plugin 0.8.16 report under maven-site-plugin 3.22.0 → fails with this reporting-exec built without the class, passes with 2.0.1; mvn verify → 6 tests and 5 ITs pass.


Removing it breaks mvn site for report plugins that still declare generate(org.codehaus.doxia.sink.Sink, Locale): jacoco-maven-plugin 0.8.16 fails with 'A required class was missing ... org/codehaus/doxia/sink/Sink'. Do not delete it in a deprecation cleanup; the test keeps the type in place.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant