gql-breaking-changes

Compare GraphQL schemas and report breaking changes between evitaDB demo and local branch.

70|7|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/FgForrest/evitaDB --skill gql-breaking-changes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gql-breaking-changes
Source: https://github.com/FgForrest/evitaDB/tree/main/.claude/skills/gql-breaking-changes
Command: npx skills add https://github.com/FgForrest/evitaDB --skill gql-breaking-changes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze GraphQL breaking changes between the public evitaDB demo server schema and the current local branch's schema, and generate a human-readable impact summary.

Core Features & Use Cases

  • Builds the project, boots the local server, and runs graphql-inspector via tools/diff-graphql-schemas.sh to compare schemas.
  • Writes a prose summary of breaking changes and their client-facing implications, tailored to downstream projects when provided.
  • Maintains a read-only workflow with no code modifications to the evitaDB tree.

Quick Start

Run the full workflow to compare schemas by building the project, starting the local server, and executing the diff script to generate a summary.

Frequently Asked Questions about gql-breaking-changes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect GraphQL breaking changes before merging my schema branch?

To detect GraphQL breaking changes, build your project and start the local server so the diff script can compare the local schema against the public evitaDB demo schema, generating both a diff file and a prose summary.

What counts as a breaking change in a GraphQL schema diff?

A breaking change in a GraphQL schema diff includes modifications that break compatibility for downstream clients, such as removing fields or changing types, which are identified by running graphql-inspector to compare schema versions.

Can I check evitaDB API compatibility for downstream TypeScript clients automatically?

Yes, you can check evitaDB API compatibility by running the schema diff workflow which evaluates compatibility against downstream TypeScript clients that auto-generate a GraphQL client, producing a detailed impact summary.

How do I run a GraphQL schema diff using graphql-inspector?

Run the GraphQL schema diff by executing the tools/diff-graphql-schemas.sh script after building the project and booting the local server, which uses graphql-inspector to compare schemas and output a diff file.

Does the GraphQL breaking changes analysis modify my source code?

No, the GraphQL breaking changes analysis maintains a read-only workflow that produces a diff file and a prose summary of client-facing implications without making any code modifications to the evitaDB tree.