DOCUMENTATION / API COMPATIBILITY

Detect breaking API changes in a GitHub workflow.

By Soumik Ghosh ยท Published

Start with one API contract and one authorized repository. Capture the baseline, inspect a changed specification, locate supported call sites, and review the evidence before enabling repository delivery.

How do I start without repository writes?

  1. Sign in and install the GitHub App only on repositories you authorize.
  2. Select the supported API or private contract and record the repository baseline.
  3. Start in shadow mode. Inspect classifications, affected usage, and unmatched patterns.
  4. Agree on intended migrations and review validation before enabling an available delivery mode.

What should a GitHub check report?

Keep the contract revisions, scanned commit, changed operation, field, rule ID, proposal checks, and blockers together. A successful static schema check is distinct from a passing application test suite. A generated draft PR is a review artifact; it is not a merge approval.

Can I use public monitoring evidence in CI?

The companion public-history exporter reads ParityDiff's credential-free public API catalog and produces a Markdown report. It does not scan your repository or provide a compatibility gate. For private repository impact, use the authorized product workflow and your own checks.

Connect an authorized repository, plan an evaluation, or inspect public history first.

API compatibility guides and tools

Rule reference