fleetlint Policy for a fleet of repositories
v0.11 (latest)
Getting started

release/api-compatibility

A library checks its API against the previous release

A capability: each stack checks it with its own tools, and every implementation that runs must pass. Implemented for dotnet, flutter, go, hugo, java, kotlin, node, python, rust.

Severityinfo
Tiers1
Stacksany
Scoperoot
Kindcapability
Sourcelibrary v0.8.0
Selected byfleetlint-recommended@v0.8.0

Requirement

A stack that publishes a library runs its API check against the previous release, in the task runner or a workflow. Each implementation says when the stack’s project is a library. 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.

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.

Sources


Generated by fleetlint docs from catalog v0.8.0.