{"id":26252607,"url":"https://github.com/fralleee/trpc-breaking-changes-detection","last_synced_at":"2025-10-15T11:58:34.850Z","repository":{"id":198188531,"uuid":"700265543","full_name":"Fralleee/trpc-breaking-changes-detection","owner":"Fralleee","description":"Automatically notify about breaking changes in your tRPC API","archived":false,"fork":false,"pushed_at":"2023-10-16T20:28:21.000Z","size":112,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-10T03:59:38.063Z","etag":null,"topics":["automation","nextjs","openapi","trpc"],"latest_commit_sha":null,"homepage":"https://medium.com/stackademic/harnessing-openapi-to-track-and-domesticate-wild-trpc-changes-050b24b33a76","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Fralleee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-10-04T09:11:22.000Z","updated_at":"2025-09-09T12:02:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"7f796d87-aab4-443e-b01b-58a190c83a32","html_url":"https://github.com/Fralleee/trpc-breaking-changes-detection","commit_stats":null,"previous_names":["fralleee/trpc-breaking-changes-detection"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Fralleee/trpc-breaking-changes-detection","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fralleee%2Ftrpc-breaking-changes-detection","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fralleee%2Ftrpc-breaking-changes-detection/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fralleee%2Ftrpc-breaking-changes-detection/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fralleee%2Ftrpc-breaking-changes-detection/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fralleee","download_url":"https://codeload.github.com/Fralleee/trpc-breaking-changes-detection/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fralleee%2Ftrpc-breaking-changes-detection/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279077175,"owners_count":26098234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-15T02:00:07.814Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","nextjs","openapi","trpc"],"created_at":"2025-03-13T17:27:45.674Z","updated_at":"2025-10-15T11:58:34.786Z","avatar_url":"https://github.com/Fralleee.png","language":"TypeScript","readme":"# TRPC Breaking Changes Detection\n\nThis repository is mentioned in my [medium article](https://medium.com/stackademic/harnessing-openapi-to-track-and-domesticate-wild-trpc-changes-050b24b33a76).\n\n## Introduction\n\nThis repository showcases an innovative approach to ensure API integrity between a Next.js server using tRPC and its corresponding clients. By auto-generating OpenAPI schemas based on the tRPC server, and then diffing these with previous versions, we can automatically detect and notify developers of breaking changes in the API.\n\n## Motivation\n\nIn dynamic development environments, APIs often undergo changes. While some of these changes are benign, others can break client-server communication, especially in mobile applications. Promptly identifying such changes can save time, prevent bugs, and ensure a seamless user experience.\n\n## Features\n\n- **Next.js with tRPC Integration:** A foundational setup showcasing how tRPC can be used with Next.js.\n- **OpenAPI Auto-Generation:** Automatically generate an OpenAPI schema based on the current tRPC setup. This schema acts as the source of truth for the API's current state.\n- **Diffing Mechanism with `openapi-diff`:** By comparing the newly generated OpenAPI schema with a baseline (e.g., from the main branch), the system can detect and report changes in the API.\n\n## Getting Started\n\n1. **Clone the Repository**\n\n   ```bash\n   git clone https://github.com/Fralleee/trpc-breaking-changes-detection.git\n   ```\n\n2. **Install Dependencies**\n\n   Navigate to the project directory and install the necessary dependencies:\n\n   ```bash\n   cd trpc-breaking-changes-detection\n   pnpm install\n   ```\n\n3. **Run the Next.js Server**\n\n   ```bash\n   pnpm run dev\n   ```\n\n4. **Generate OpenAPI Schema**\n\n   Instructions on how to generate the schema based on your current tRPC setup.\n\n   ```bash\n   pnpm run generate-schema\n   ```\n\n5. **Check for Breaking Changes**\n\n   Start by creating a new branch and introducing either breaking or non-breaking modifications to the tRPC server. The automated action is configured to activate upon the creation of new pull requests, provided they are not set to draft status.\n\n## Contributing\n\nFeel free to raise issues or submit pull requests. Any contributions, big or small, are highly appreciated!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffralleee%2Ftrpc-breaking-changes-detection","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffralleee%2Ftrpc-breaking-changes-detection","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffralleee%2Ftrpc-breaking-changes-detection/lists"}