[BUILD-417] Remove Clirr plugin Created: 16/Nov/20  Updated: 04/May/22  Resolved: 03/May/22

Status: Closed
Project: Build
Component/s: None
Affects Version/s: None
Fix Version/s: POMs 46

Type: Task Priority: Neutral
Reporter: Maxime Michel Assignee: Maxime Michel
Resolution: Done Votes: 0
Labels: artt, foundation_team
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to BUILD-771 Take out binary compatibility from pi... Selected
is related to BUILD-407 Improve API compatibility reports Closed
is related to BUILD-758 Remove Clirr altogether Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: Improve QA setup

 Description   

We use japicmp but the generated site is still done by Clirr. We currently have both japicmp & Clirr Maven plugins configured. This ticket would be about:

  • removing Clirr's plugin
  • make the release plugin pick up on sites done by japicmp instead
  • do not generate the japicmp report inside Maven sites, simply discard the report altogether
    • this isn't straightforward because there are exceptions in some modules (example) that aren't picked up when running mvn site
    • instead, allow to see the HTML reports in the scope of BUILD-771


 Comments   
Comment by Maxime Michel [ 14/Feb/22 ]

mgeljic do you please have any leads for this one implementation-wise?

Comment by Mikaël Geljić [ 14/Feb/22 ]

Nothing too elaborate, should be mostly maven reporting config => https://siom79.github.io/japicmp/MavenPlugin.html#Site_report;
+/- aggregate reports for multi-module repos, but it may not look like the plugin supports that.

On the other hand, how much is it worth doing? (~ DEV-1209)
I'm thinking we'll stop releasing maven sites for modules eventually (unless we can prove tangible value/traffic). So in terms of reports, there will be two types of artifacts we'll be interested in then:

  • public docs & references, upon releases: thinking Javadoc, perhaps API docs more meaningfully nowadays
  • internal reports for quality tracking/gatekeeping, upon CI; clearly maven sites have been terribly useless for this, but whatever comes instead would likely consume the same maven reports here (much like publishing artifacts on Jenkins).
Generated at Sun Feb 11 23:41:43 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.