Continuous Integration

GraphQL Inspector can be used with any Continuous Integration. It’s easy!

Installation

GraphQL Inspector already has CLI, but we developed a more suited approach for consuming it in CI/CD. It’s called CLI for CI.

Install it using:

npm i --global @graphql-inspector/ci

yarn global add @graphql-inspector/ci

pnpm add --global @graphql-inspector/ci

bun add --global @graphql-inspector/ci

You need to install graphql globally too:

npm i --global graphql

yarn global add graphql

pnpm add --global graphql

bun add --global graphql

The most common use case is schema diffing and all the other features are never touched. That’s why we decide to make each feature pluggable.

In GraphQLI Inspector CLI for CI, you’re able to install exactly what you want to use. Each command is an installable package.

Commands

Here’s a list of available commands. Pick one or a few.

Loaders

“Loader” is a fairly new concept. Since each command is a package, we decided to do the same for schema/document loading logic.

Depending on the source of GraphQL Schema or GraphQL Documents, pick one or few from the list.

Now you know where everything is but let’s find out how to make use of it.

Usage

Let’s take for example Schema Diffing and assume your latest schema.graphql is under master branch.

You want to compare two GraphQL Schemas:

npm i --global @graphql-inspector/diff-command

yarn global add @graphql-inspector/diff-command

pnpm add --global @graphql-inspector/diff-command

bun add --global @graphql-inspector/diff-command

You need to be able to load schema.graphql from disk and from origin/master on Git:

npm i --global @graphql-inspector/graphql-loader @graphql-inspector/git-loader

yarn global add @graphql-inspector/graphql-loader @graphql-inspector/git-loader

pnpm add --global @graphql-inspector/graphql-loader @graphql-inspector/git-loader

bun add --global @graphql-inspector/graphql-loader @graphql-inspector/git-loader

With everything installed, you can use the command below in your CI setup:

graphql-inspector diff 'git:origin/master:./schema.graphql' 'schema.graphql'

Example

Now, when you push your changes you would see the following:

Recommended Workflow

We recommend to automate the workflow and use husky to run $ graphql-inspector introspect.

{
  // ...
  "scripts": {
    "graphql:dump": "graphql-inspector introspect schema.js --write schema.graphql"
  },
  "husky": {
    "hooks": {
      "pre-commit": "pnpm graphql:dump && git add schema.graphql"
    }
  }
}

This way your schema.graphql is always in sync with the code, on each commit.

Using Docker Image

You can use GraphQL Inspector Docker image in any CI/CD provider. For example, in CircleCI it would look like this:

version: 2
jobs:
  build:
    docker:
      - image: kamilkisiela/graphql-inspector
    steps:
      - checkout
      - run:
          name: GraphQL Inspector
          command: 'graphql-inspector diff "git:origin/master:./schema.graphql" "schema.graphql"'