release/api-compatibility/python
A library checks its API against the previous release
Implements release/api-compatibility for python.
| Severity | info |
| Tiers | 1 |
| Stacks | python |
| Scope | root |
| Kind | outcome |
| Source | library v0.4.0 |
| Selected by | fleetlint-recommended@v0.4.0 |
Requirement
A pyproject [project] without scripts runs griffe check against the previous tag.
Why
A breaking change in a minor release is found by every user at once; the check finds it before the tag.
Applies when
toml("pyproject.toml") != null && has(toml("pyproject.toml").project) && !has(toml("pyproject.toml").project.scripts)Fix
Run griffe check <package> --against $(git describe --tags --abbrev=0) in the release workflow.
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
- https://semver.org/spec/v2.0.0.html (standard)
- https://fleetlint.org/baseline/#releases (convention)
- https://mkdocstrings.github.io/griffe/guide/users/checking/ (spec)
- https://fleetlint.org/stacks/#python
Generated by fleetlint docs from catalog v0.4.0.