Join us from October 8-10 in New York City to learn the latest tips, trends, and news about GraphQL federation and API platform engineering.Join us for GraphQL Summit 2024 in NYC
Start for Free


Learn about the process of deploying updates to supergraphs

In , a launch represents the complete process of applying a set of updates to a . are usually triggered by making changes to one of your published .

Updates that trigger a include:

  • Adding, removing, or modifying types and in a
  • Adding or removing entire s
  • Migrating types or fields between subgraphs
  • Modifying your cloud router's configuration
  • Updating your federation version

A launch might consist entirely of changes that don't affect your supergraph's public API (such as migrating fields between ).

You can trigger a launch manually by calling the GraphOS Platform API.

Launch status

Your supergraph's Launches page in enables you to observe and monitor the process for both in-progress and past launches:

The green PUBLISHED badge indicates which launch corresponds to your supergraph's current published schema.

Selecting a launch provides a breakdown of its individual steps and any errors or warnings that occurred during it:

From this detail view, you can view the timestamp and other details for each step in the launch process. You can also view the launch's associated (or any build errors if failed).

What's in a launch?

A GraphOS launch proceeds through the following steps:

If composition succeeds...
If composition fails,
the launch fails
You publish a subgraph
schema update to GraphOS
GraphOS performs supergraph schema
composition with latest subgraph schemas
Updated supergraph schema is
made available via Apollo Uplink
GraphOS updates Studio UI and sends
build status webhook notifications
to reflect new published schema
Your router begins using
the new published schema
Launch complete

Manually trigger launch

This feature is in preview. Your questions and feedback are highly valueddon't hesitate to get in touch with your Apollo contact.

You can trigger a launch manually by calling the GraphOS Platform API to publish subgraph schema updates. This is useful for deployments that require progressive rollouts, where different environments have unique subgraph schemas. In this scenario, you can publish the subgraph schemas for an environment, wait for the completed launch (and any downstream launches), then retrieve the supergraph schema with the launch ID.

For an example workflow using GraphOS Platform API to manually trigger a launch, see the Advanced deployment workflow for blue-green deployment.

Publish Schemas
Rate articleRateEdit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy