release/api-compatibility
A library checks its API against the previous release
A capability: each stack checks it with its own tools. Implemented for dotnet, flutter, go, hugo, java, kotlin, node, python, rust.
Combine: all. Every implementation that runs must pass: each stack in the repository meets the requirement with its own tools.
| Severity | info |
| Tiers | 1 |
| Stacks | any |
| Scope | root |
| Kind | capability |
| Source | library v0.3.1 |
| Selected by | fleetlint-recommended@v0.3.1 |
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.
See: https://fleetlint.org/baseline/#releases
Generated by fleetlint docs from catalog v0.3.1.