Validate schema changes with GraphQL inspector to prevent breaking changes

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem to solve

GraphQL schema changes happen frequently, and it is easy to introduce breaking changes. We need to prevent this automatically.

Intended users

User experience goal

Attempts to contribute a breaking schema change are flagged and prevented.

Proposal

Introduce new static analysis job in our CI pipeline that makes use of https://github.com/kamilkisiela/graphql-inspector

Documentation

We should also document what a breaking change is so that the CI job message can direct to a handbook page for help.

Availability & Testing

We need to add a new static analysis CI job

What does success look like, and how can we measure that?

Success is being able to prevent MRs containing breaking GraphQL schema changes from merging automatically

Is this a cross-stage feature?

This affects all stages that make use of GraphQL

Links / references

/cc @.luke @cablett @digitalmoksha

Edited by 🤖 GitLab Bot 🤖