Using Rover in CI/CD

You can use Rover in any CI/CD environment that uses a Rover-supported operating system (Linux, MacOS, or Windows). Most commonly, this is to run schema checks with rover graph check or rover subgraph check.

Rover's installation is similar to many other CLI tools, but the recommended method varies depending on which provider you're using. We've included instructions for some of the most common CI/CD providers:

CircleCI
GitHub Actions
Bitbucket Pipelines.

If you're using Rover with a CI/CD provider not listed here, we'd love for you to share the steps by opening an issue or pull request!

CircleCI

Linux jobs using the `curl` installer

Normally when installing, Rover adds the path of its executable to your $PATH. However, CircleCI doesn't use the $PATH variable between run steps. This means that if you install Rover and try to run it in the next step, you get a command not found: rover error.

To fix this, you can modify the $PATH and append it to $BASH_ENV. $BASH_ENV is executed at the beginning of each step, enabling any changes to be maintained across steps. You can add Rover to your $PATH using $BASH_ENV like this:

1
echo 'export PATH=$HOME/.rover/bin:$PATH' >> $BASH_ENV

After you install Rover and modify the $BASH_ENV as shown, Rover should work like normal.

Important: Because the rover config auth command is interactive, you need to authenticate using an environment variable in your project settings.

Full example

1
# Use the latest 2.1 version of CircleCI pipeline process engine. See: https://circleci.com/docs/2.0/configuration-reference
2
version: 2.1
3

4
jobs:
5
  build:
6
    docker:
7
      - image: cimg/node:15.11.0
8
    steps:
9
      - run:
10
          name: Install
11
          command: |
12
            # download and install Rover
13
            curl -sSL https://rover.apollo.dev/nix/v0.1.0 | sh
14

15
            # This allows the PATH changes to persist to the next `run` step
16
            echo 'export PATH=$HOME/.rover/bin:$PATH' >> $BASH_ENV
17
      - checkout
18
      # after rover is installed, you can run it just like you would locally!
19
      - run: rover graph check my-graph@prod --schema ./schema.graphql

GitHub Actions

Displaying schema check results on GitHub pull requests

If you use GitHub Actions to automatically run schema checks on every pull request (as shown below), you can install the Apollo Studio GitHub app to provide links to the results of those checks alongside your other pull request checks:

For these entries to display correctly, you need to make sure Rover associates the schema check execution with the pull request's HEAD commit, as opposed to the merge commit that GitHub adds. To guarantee this, set the APOLLO_VCS_COMMIT environment variable in your action's configuration, like so:

1
env:
2
  APOLLO_VCS_COMMIT: ${{ github.event.pull_request.head.sha }}

Linux/MacOS jobs using the `curl` installer

Normally when installing, Rover adds the path of its executable to your $PATH. However, GitHub Actions doesn't use the $PATH variable between run steps. This means that if you install Rover and try to run it in the next step, you get a command not found: rover error.

To fix this, you can append Rover's location to the $GITHUB_PATH variable. $GITHUB_PATH is similar to your system's $PATH variable, and additions to $GITHUB_PATH can be used across multiple steps. You can modify it like this:

1
echo "$HOME/.rover/bin" >> $GITHUB_PATH

Important: Because the rover config auth command is interactive, you need to authenticate using an environment variable in your project settings.

GitHub actions uses project environments to set up secret environment variables. In your action, you choose a build.environment by name and set build.env variables using the saved secrets.

The following is a full example script, showing how to choose an apollo environment and set an APOLLO_KEY variable:

Full example

1
# .github/workflows/check.yml
2

3
name: Check Schema
4

5
# Controls when the action will run. Triggers the workflow on push or pull request events
6
on: [push, pull_request]
7

8
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
9
jobs:
10
  # This workflow contains a single job called "build"
11
  build:
12
    # The type of runner that the job will run on
13
    runs-on: ubuntu-latest
14

15
    # https://docs.github.com/en/actions/reference/environments
16
    environment: apollo
17

18
    # https://docs.github.com/en/actions/reference/encrypted-secrets
19
    # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsenv
20
    env:
21
      APOLLO_KEY: ${{ secrets.APOLLO_KEY }}
22
      APOLLO_VCS_COMMIT: ${{ github.event.pull_request.head.sha }}
23

24
    # Steps represent a sequence of tasks that will be executed as part of the job
25
    steps:
26
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
27
      - uses: actions/checkout@v2
28

29
      - name: Install Rover
30
        run: |
31
          curl -sSL https://rover.apollo.dev/nix/v0.1.0 | sh
32

33
          # Add Rover to the $GITHUB_PATH so it can be used in another step
34
          # https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
35
          echo "$HOME/.rover/bin" >> $GITHUB_PATH
36
      - name: Run check against prod
37
        run: |
38
          rover graph check my-graph@prod --schema ./test.graphql

Bitbucket Pipelines

The following is a full example configuration for Bitbucket Pipelines. It shows how to:

Run rover subgraph check for each commit on all branches
Run rover subgraph publish to keep the schema definition of your main branch in-sync with a base variant (@local in this case)

The example uses the following Pipeline Repository Variables to make the pipeline configuration portable across different repositories:

APOLLO_KEY
APOLLO_SUBGRAPH_NAME, which represents the name of the subgraph you're running schema checks for
APOLLO_LOCAL_PORT, which represents the port number of the base variant

Full example

1
# ./bitbucket-pipelines.yml
2

3
image: node
4

5
definitions:
6
  steps:
7
    - step: &rover-subgraph-check
8
        name: "[Rover] Subgraph Check"
9
        caches:
10
          - node
11
        script:
12
          - 'echo "Subgraph name: $APOLLO_SUBGRAPH_NAME"'
13
          - npx -p @apollo/rover@latest
14
            rover subgraph check my-graph@prod
15
            --name $APOLLO_SUBGRAPH_NAME
16
            --schema ./schema.graphql
17

18
    - step: &local-publish
19
        name: "[Rover] @local publish (sync with main/master)"
20
        caches:
21
          - node
22
        script:
23
          - 'echo "Subgraph name: $APOLLO_SUBGRAPH_NAME"'
24
          - 'echo "Local variant port: $APOLLO_LOCAL_PORT"'
25

26
          - npx -p @apollo/rover@latest
27
            rover subgraph publish my-graph@local
28
            --name $APOLLO_SUBGRAPH_NAME
29
            --schema ./schema.graphql
30
            --routing-url http://localhost:$APOLLO_LOCAL_PORT/graphql
31

32
pipelines:
33
  default:
34
    - step: *rover-subgraph-check
35

36
  branches:
37
    '{main,master}':
38
      - step: *rover-subgraph-check
39
      - step: *local-publish

Using With `npm`/`npx`

If you're running in a Node.js workflow, it might be easier to use the NPM distribution of Rover. This way, you don't need to adjust the PATH at all to run Rover, and it might fit better into your existing workflow.

You can use Rover by adding it to your package.json dependencies using these instructions and then execute it using npm scripts, similar to other workflows you might already have. If you don't want to install Rover as a dependency, you can run it with npx by using the -p flag:

1
npx -p @apollo/rover rover graph check my-graph@prod --schema=./schema.graphql

Since most commands require you be authenticated, see the above sections for instructions on how to add environment variables for your CI/CD provider.

Edit on GitHub

Proxy configuration

Conventions