Documentation
¶
Overview ¶
Command apicompat holds the API contract to the last release (`make gate-api-compat`, versioning-release.md §6).
It compares `api/openapi.yaml` in the working tree with the same file at the newest `v*` tag behind HEAD, through oasdiff, and classifies what changed by versioning-release.md §2. A breaking change fails unless it is marked: a Conventional Commit title with `!` before the colon, or a `BREAKING CHANGE:` footer.
With -base, only the breaking changes this branch adds are judged, and only this branch's commits (and -text, the pull request's title and description) can mark them: one marked break since the tag must not carry every later one through unmarked. A break already on the base was judged when it landed there. Without -base, every break since the tag is judged against every commit since it.
Usage: apicompat [-since <ref>] [-base <ref>] [-text <file>]
Source Files