Schema registration via the Rover CLI

If you're using a GraphQL server that doesn't support schema reporting, you can register your schema via the Rover CLI.

Registering a non-federated schema

1. If you haven't yet:

   • Install the Rover CLI
   • Authenticate Rover with Apollo Studio

2. Decide how you'll provide your server's schema to Rover. You can either:

   • Use a .gql or .graphql file saved on your local machine, or
   • Perform an introspection query on your running server to fetch the schema

3. Run the rover graph publish command, providing your schema in one of the ways shown:

   Bash

   1
   # Provide a local .graphql file path
   2
   rover graph publish my-graph@my-variant --schema ./schema.graphql
   3
   
   4
   # Provide an introspection result via stdin
   5
   rover graph introspect http://localhost:4000 | rover graph publish my-graph@my-variant --schema -

   Copy

   As shown, the first positional argument you provide rover graph publish is a graph ref, a string that specifies a particular variant of a particular graph in Studio.

Registering federated schemas

See Setting up managed federation.

Registering with continuous delivery

To get the most out of Studio, you should register each update to your production schema as soon as it occurs. Consequently, schema registration should be part of your continuous delivery pipeline.

Here's a sample continuous delivery configuration for CLI-based schema registration using CircleCI:

1
version: 2
2

3
jobs:
4
  build:
5
    docker:
6
      - image: circleci/node:8
7

8
    steps:
9
      - checkout
10

11
      - run: npm install
12

13
      - run:
14
          name: Install Rover
15
          command: |
16
            # download and install Rover
17
            curl -sSL https://rover.apollo.dev/nix/v0.3.0 | sh
18

19
            # This allows the PATH changes to persist to the next `run` step
20
            echo 'export PATH=$HOME/.rover/bin:$PATH' >> $BASH_ENV
21

22
      # Start the GraphQL server.  If a different command is used to
23
      # start the server, use it in place of `npm start` here.
24
      - run:
25
          name: Starting server
26
          command: npm start
27
          background: true
28

29
      # make sure the server has enough time to start up before running
30
      # commands against it
31
      - run: sleep 5
32

33
      # When running on the 'main' branch, push the latest version
34
      # of the schema to Apollo Studio.
35
      - run: |
36
          if [ "${CIRCLE_BRANCH}" == "main" ]; then
37
            rover graph publish my-graph@my-variant --schema ./schema.graphql
38
          fi