Skip to content

Commit 11d4939

Browse files
reuvenharrisonclaude
reuvenharrison
and
claude
committed
docs: add team workflow callout to BREAKING-CHANGES.md
Adds a parallel "For teams:" note at the top of BREAKING-CHANGES.md pointing to oasdiff.com. A reader who landed here is detecting breaking changes in CI; the natural next question is "now who approves them?" — answering it inline (per-change PR comment with approve/reject + commit-status checks) at the moment of highest intent. Same callout style as the diff-engine note above it; one short sentence, no marketing prose. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 19a7a94 commit 11d4939

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

‎docs/BREAKING-CHANGES.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ These commands are typically used in the CI to report or prevent breaking change
66

77
> **Note:** `breaking` and `changelog` run on the diff engine described in [DIFF.md](DIFF.md). The flags and concepts there — extension tracking, path matching, `allOf` flattening, the path-prefix family, header case, `--allow-external-refs`, `--fail-on-diff` — apply here too, in addition to the breaking-specific options below.
88
9+
> **For teams:** [oasdiff.com](https://www.oasdiff.com) wraps these commands with a per-change PR comment, one-click approve/reject buttons, and commit-status checks — so reviewers can act on each breaking change directly from the pull request.
10+
911
### Example: display breaking changes
1012
```
1113
oasdiff breaking https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test1.yaml https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test3.yaml

0 commit comments

Comments
 (0)