Awesome Reviewers

Verification · Static analysis · API compatibility checking

Library API diff

Compare the exported symbols and signatures of a package against its last release.

How to build it

  1. Run the public API comparison tool for the package's language against the last release tag.
  2. Fail the release job when the diff shows breaking changes and the version is not a major bump.
  3. Attach the API diff output to the release or the pull request.

Signals in a repository

  • A cargo semver-checks step in a release workflow or a japicmp plugin in a Maven or Gradle build.
  • An api-extractor.json file or a griffe check step in CI.

In practice

No scanned repository runs a tool for this check. The steps above are the only guidance.