BreakCheck

OpenAPI breaking-change Checks for GitHub

Fail the PR before you break your API.

BreakCheck is a GitHub Check that catches OpenAPI breaking changes and pings Slack — install the App, point at your schema, ship safer.

Install on GitHubSee how it works
acme/payments · PR #184
✓

lint

2m 11s

pass
✓

tests

4m 03s

pass
✕

BreakCheck

removed GET /v1/invoices/{id}

fail

The problem

You merge a “small” OpenAPI tweak. Partner clients break. Nobody saw it in review because YAML doesn’t shout. Speakeasy / Bump / Optic are full API platforms. BreakCheck is the green/red Check you install today.

How it works

  1. 01

    Install the GitHub App on the repo that owns your OpenAPI spec

  2. 02

    Point BreakCheck at your schema (`.breakcheck.yml`)

  3. 03

    Breaking change on a PR → red Check (+ Slack on Team+)

OpenAPI breaking-change Checks for GitHub

Install the GitHub App on the repo that owns your OpenAPI spec. Then point BreakCheck at your schema.

Install on GitHubSign in

Plans

Free

$0

  • 1 private repo
  • 50 Checks/mo
  • no Slack

Team

$49/mo

  • 5 repos
  • unlimited Checks
  • Slack
  • 14-day history

Scale

$149/mo

  • 25 repos
  • unlimited Checks
  • Slack
  • 90-day history
  • priority queue
  • Scale overage +$9/repo/mo