Test for API breaking changes in CI #120
Labels
A-api
Area: Stable API
A-infra
Area: Infrastructure and CI magic :sparkles:
C-enhancement
Category: New feature or request
Milestone
Currently, the CI only checks that the
marker_api
crate can be compiled on stable. It's up to the reviewer and programmer to ensure that the API doesn't break. This is fine right now, as the API is under active development and still changes frequently. However, the goal of Marker is to create a stable API.The rust ecosystem has tools to prevent accidental public API changes, like cargo-semver-checks. Once v0.1.0 or a higher version has been released, I think it would be good to utilize such a tool.
This issue is blocked for now until v0.1.0 or a later point, when we've defined what stability means for marker and ii API breakage will be allowed under specific circumstances.
The text was updated successfully, but these errors were encountered: