rover-actions

The code in this repository is experimental and has been provided for reference purposes only. Community feedback is welcome but this project may not be supported in the same way that repositories in the official Apollo GraphQL GitHub organization are. If you need help you can file an issue on this repository, contact Apollo to talk to an expert, or create a ticket directly in Apollo Studio.

install-rover-cli

This is a GitHub Action to install the Apollo Rover CLI on action runners. Once installed, rover is added to PATH, so it can be used in subsequent steps.

Inputs

Name	Description	Default
version	The version of rover to install	latest

Usage

Installing a specific version of rover:

- uses: apollosolutions/rover-actions/install-rover-cli@v1
  with:
    version: 0.18.1

Install the latest version:

- uses: apollosolutions/rover-actions/install-rover-cli@v1

Run a rover command after install:

- uses: apollosolutions/rover-actions/install-rover-cli@v1
- name: Run schema check
  env:
    APOLLO_KEY: ${{ secrets.APOLLO_KEY }}
  run: rover subgraph check ${{ vars.APOLLO_GRAPH_REF }} --name subgraph-name --schema ./path/to/schema.graphql

subgraph-check

This is a GitHub Action to perform the rover subgraph check command.

Inputs

Name	Description	Required	Default
apollo-key	Your Apollo Studio API key	*
graph-ref	<NAME>@<VARIANT> of graph in Apollo Studio	*
name	The name of the subgraph	*
schema	The schema file to check	*
background	Set to true if the check should run asynchronously		false
query-count-threshold	The minimum number of times a query or mutation must have been executed in order to be considered in the check operation
query-percentage-threshold	The minimum percentage of times a query or mutation must have been executed, relative to the request count, for it to be considered in the check (0 <= x <= 100)
validation-period	Size of the time window with which to validate schema against (i.e. 24h or 1w 2d 5h)
log	Specify Rover's log level		info
format	Specify Rover's log format type [plain, json]		plain
client-timeout	Configure the timeout length (in seconds) when performing HTTP(S) requests		30

Usage

Note: You must first install the Rover CLI

- uses: apollosolutions/rover-actions/install-rover-cli@v1
- uses: apollosolutions/rover-actions/subgraph-check@v1
  with:
    apollo-key: ${{ secrets.APOLLO_KEY }}
    graph-ref: ${{ vars.APOLLO_GRAPH_REF }}
    name: subgraph-name
    schema: ./path/to/schema.graphql

subgraph-publish

This is a GitHub Action to perform the rover subgraph publish command.

Inputs

Name	Description	Required	Default
apollo-key	Your Apollo Studio API key	*
graph-ref	<NAME>@<VARIANT> of graph in Apollo Studio	*
name	The name of the subgraph	*
schema	The schema file to check	*
routing-url	Url of the running subgraph where a supergraph can route operations	On first publish	<empty>
allow-invalid-routing-url	Bypasses warnings and the prompt to confirm publish when the routing url is invalid in TTY environment
log	Specify Rover's log level		info
format	Specify Rover's log format type [plain, json]		plain
client-timeout	Configure the timeout length (in seconds) when performing HTTP(S) requests		30

Usage

Note: You must first install the Rover CLI

- uses: apollosolutions/rover-actions/install-rover-cli@v1
- uses: apollosolutions/rover-actions/subgraph-publish@v1
  with:
    apollo-key: ${{ secrets.APOLLO_KEY }}
    graph-ref: ${{ vars.APOLLO_GRAPH_REF }}
    name: subgraph-name
    schema: ./path/to/schema.graphql
    routing-url: https://sample.apollo.dev/graphql