{"repo":"oasdiff/oasdiff-action","free":true,"listed":false,"github":"https://github.com/oasdiff/oasdiff-action","clone":"git clone https://github.com/oasdiff/oasdiff-action.git","description":"GitHub Actions that detect breaking changes in your OpenAPI specs and post a review on every pull request","language":"Shell","stars":64,"topics":["github-actions","openapi","breaking-changes","changelog","diff","openapi-spec","openapi3","swagger"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"oasdiff-action GitHub Actions that check your OpenAPI specs for breaking changes on every pull request. They post a side-by-side review of the changes as a PR comment and, with Pro, let your team approve or reject each change with a commit-status check that gates the merge. Based on oasdiff. Contents - Quick start - Versioning - Free actions - Check for breaking changes - Generate a changelog - Generate a diff report - Validate a single spec - Configuring with .oasdiff.yaml - Spec paths - Pro: Approve and gate changes Quick start Add this workflow to .github/workflows/oasdiff.yaml to block PRs that introduce breaking API changes. Replace openapi.yaml with the path to your OpenAPI spec: This compares your spec on the PR branch against the base branch and fails the workflow if any breaking changes are found. When changes are found it posts a side-by-side review link as a PR comment; drop github-token and the pull-requests: write permission to keep that link in the job summary instead. --- Versioning The examples here pin the action at @v0 , the moving major-version tag. It always points at the latest v0.x.y release, so you get every later patch and minor (including review and PR-comment improvements) automatically, with no workflow change: @v0 only advances on stable releases, never on prereleases. If you prefer to control upgrades yourself, pin to a specific release tag from the Releases page and bump it when you choose. @main runs the unreleased tip and is meant for trying ch","default_branch":null,"files":null,"tree":[],"storefront":"/r/oasdiff","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/oasdiff/oasdiff-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}