fleetlint Policy for a fleet of repositories
v0.5
Getting started

release/api-compatibility/java

A library checks its API against the previous release

Implements release/api-compatibility for java.

Severityinfo
Tiers1
Stacksjava
Scoperoot
Kindoutcome
Sourcelibrary v0.2.0
Selected byfleetlint-recommended@v0.2.0

Requirement

A library published with maven-publish or Maven deploy runs japicmp or revapi against the previous release.

Why

A breaking change in a minor release is found by every user at once; the check finds it before the tag.

Applies when

grep("**/build.gradle*", "maven-publish").size() > 0 || grep("**/pom.xml", "<distributionManagement>").size() > 0

Fix

Add japicmp-maven-plugin (or me.champeau.gradle.japicmp) comparing against the previous release version.

Agent instruction: Add the stack’s API compatibility tool to the release workflow, comparing against the latest tag; on a breaking change bump the major version instead of silencing the tool.

See: https://fleetlint.org/baseline/#releases, https://fleetlint.org/stacks/#java


Generated by fleetlint docs from catalog v0.2.0.