The latest articles on DEV Community by Turya Kalburgi (@turyakalburgi). https://dev.to/turyakalburgi https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F4129634%2Fd5a66be3-cff7-4d22-89ef-7acbcb6460fb.png https://dev.to/turyakalburgi en Turya Kalburgi Thu, 17 Sep 2026 10:20:32 +0000 https://dev.to/turyakalburgi/how-i-built-a-lightweight-github-action-to-stop-breaking-api-changes-in-ci-3jam https://dev.to/turyakalburgi/how-i-built-a-lightweight-github-action-to-stop-breaking-api-changes-in-ci-3jam <p>Breaking API contracts silently slipping into production is a pain point almost every engineering team hits eventually. A backend PR renames a field, drops a property, or mutates a type—and downstream services or frontends immediately break.</p> <p>To catch this before merges happen, I built <strong>API Drift Sentinel</strong>—a zero-config GitHub Action that detects breaking OpenAPI/Swagger schema changes directly in your PR workflows.</p> <h3> Why not existing tools? </h3> <p>Most existing solutions either require heavy external cloud platforms or demand installing full Node/Python runtimes during the CI run. </p> <p>I wanted something drop-in and ultra-fast:</p> <ul> <li> <strong>Zero config:</strong> Works out of the box for standard OpenAPI 3.0 / Swagger specs.</li> <li> <strong>Fail-fast:</strong> Exits with code <code>1</code> and emits inline GitHub PR annotations whenever breaking changes are caught.</li> <li> <strong>Pre-bundled with esbuild:</strong> Bundled down to a standalone script, running in ~50ms without an <code>npm install</code> step on your runner.</li> </ul> <h3> How to use it </h3> <p>Add this step to your GitHub Actions workflow (e.g., <code>.github/workflows/ci.yml</code>):</p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code> yaml - name: Check for Breaking API Changes uses: Turya-Kalburgi/api-drift-sentinel@v1 with: base-spec: 'openapi.yaml' </code></pre> </div> devops webdev opensource github