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

release/api-compatibility

A library checks its API against the previous release

Severityinfo
Tiers1
Stacksany
Scoperoot
Kindoutcome
Sourcelibrary v0.0.0-20261011205826-ecb4e9b3ffd4
Selected byfleetlint-recommended@0.1.0

Requirement

A repository that publishes a library (a package manifest without private, a src/lib.rs or [lib], a pyproject [project] without scripts, a Go module without a main package, a Gradle module with maven-publish) runs the stack’s API check: gorelease or apidiff, griffe, cargo semver-checks, api-extractor with a committed report, binary-compatibility-validator. Another tool is added with accept:.

Why

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

Applies when

("node" in repo.stacks && json("package.json") != null && !(has(json("package.json").private) && json("package.json").private == true)
  && (has(json("package.json").main) || has(json("package.json").exports) || has(json("package.json").types)))
|| ("rust" in repo.stacks && (file("src/lib.rs") || text("Cargo.toml").contains("[lib]"))) || ("python" in repo.stacks && toml("pyproject.toml") != null && has(toml("pyproject.toml").project) && !has(toml("pyproject.toml").project.scripts)) || ("go" in repo.stacks && !exists("**/main.go")) || ("kotlin" in repo.stacks && grep("**/build.gradle*", "maven-publish").size() > 0)

Fix

Add the stack’s API compatibility check to the release target or workflow, comparing against the previous tag (see https://fleetlint.org/stacks/).

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


Generated by fleetlint docs from catalog v0.0.0-20261011205826-ecb4e9b3ffd4.