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

release/api-compatibility/kotlin

A library checks its API against the previous release

Implements release/api-compatibility for kotlin.

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

Requirement

A Gradle build that publishes with maven-publish checks its ABI: the Kotlin Gradle plugin’s abiValidation (or the binary-compatibility-validator plugin) with committed .api dumps, or japicmp.

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

Fix

Enable abiValidation in the Kotlin Gradle plugin (or apply binary-compatibility-validator), commit the api/ dumps and let ./gradlew check run the ABI check.

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/#kotlin-jvm--android


Generated by fleetlint docs from catalog v0.2.0.