yesamer opened a new pull request, #6704: URL: https://github.com/apache/incubator-kie-drools/pull/6704
## Summary This PR restores and improves Javadoc generation and API compatibility reporting for kie-api. The changes ensure that kie-api publishes its Javadoc jar during regular builds, refresh public API documentation for the current JDK baseline, and reintroduce automated API compatibility checks using RevAPI and JApiCmp. In addition, the PR improves the documentation of long-deprecated APIs by adding clearer deprecation details, including explicit `since` and `forRemoval` metadata. ## What changed - enabled Javadoc jar generation for kie-api as part of the standard build lifecycle - improved the main Javadoc overview and refreshed documentation on several core public runtime APIs - enriched existing deprecated APIs with clearer Javadoc explanations and explicit `@Deprecated(since = ..., forRemoval = true)` metadata - configured RevAPI to run during `verify` against the latest released kie-api artifact - added a RevAPI configuration to treat added attributes on existing `@Deprecated` annotations as documentation-only changes - configured JApiCmp reporting to compare old and new kie-api versions - limited compatibility analysis to public API by excluding internal packages - added minor API documentation consistency improvements such as explicit `@Override` annotations where appropriate ## Why This aligns kie-api with the goal of having reliable Javadoc publication and automated API compatibility reporting while keeping the compatibility tooling focused on meaningful public API changes. It also improves the quality of the published API documentation by clarifying intended usage, session semantics, and the status of long-deprecated methods without introducing functional API changes. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
