Rover Build

Manage and maintain Apollo GraphOS graphs using the Rover CLI within Jenkins pipeline steps — eliminating manual command entry and reducing human error in graph operations.

Prerequisites

  • Jenkins tool registered in Opsera Tool Registry

  • Jenkins Job created as a Shell Script jobApollo API key stored as an Opsera parameter (e.g.opsera-rover-apollo-key)

  • SCM repository with GraphQL schema/supergraph project registered

Pipeline setup

1

Create Rover build step

Tool = Command Line, Step Type = Script. In Step Settings choose the Jenkins Tool and a Shell Script Job.

2

Configure source and commands

Set SCM tool, Repository, and Branch. Define the Rover commands. Map the Apollo key as an input parameter — the key name must match exactly (e.g. opsera-rover-apollo-key).

3

Select Rover version and reports

Choose the Rover version from the Dependency dropdown. Optionally enable the Report Details toggle to ingest reports without command-line path specification.

4

Run and view logs

Click Start Pipeline. Open pipeline → Summary → Pipeline Logs → Console Output to view rover build details.

circle-info

Points to remember

  • The Apollo API key parameter mapping is mandatory — the Rover CLI will fail authentication if the key is not correctly mapped as an input parameter in the step.

  • Always store the Apollo key as a global parameter in Tool Registry — this ensures it is masked in logs and not exposed in pipeline configuration.

  • The Report Details toggle eliminates the need to hardcode report file paths in scripts, making the pipeline configuration portable across environments.

Last updated