[CAMEL-10785] Add revapi-maven-plugin for API modification reports

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.22.0
• Component/s: build system
• Estimated Complexity: Moderate
• Assignee: Onder Sezgin
• Reporter: Paolo Antinori
• Created: 03/Feb/17 14:14
• Updated: 02/Apr/18 06:35
• Resolved: 02/Apr/18 06:35

Description

http://revapi.org/modules/revapi-maven-plugin/

Is a Maven plugin to help preventing breaking public APIs or to keep track of major change between version.

This is the output of a sample run over camel-core/2.17.0 vs. camel-core/2.18.0

https://camel-revapi.netlify.com/revapi-report.html

The plugin is quite powerful in its capabilities.

This is the list of the event it can detect:

http://revapi.org/modules/revapi-java/differences.html

But it can obviously be pre-configured to disable not interesting finds or to completely whitelist some occurrences.

See for example, how the guys of Drools configure their:

https://github.com/etirelli/droolsjbpm-knowledge/blob/647deee821281a507035a96025ac44d626e535ab/kie-api/src/build/revapi-config.json

The plugin can make the build job fail, in case it finds a breaking change (probably too strict requirement for Camel) or just produce it's report.

I'm attaching my sample pom.xml if people want to have something to start playing with.

Issue Links

• links to: GitHub Pull Request #2273
• links to: GitHub Pull Request #2273