Implement approved proposals
Use Rover and schema checks to implement only approved changes
This feature is only available with a
You can test it out by signing up for a free
This article describes actions in the Proposal implementation and Publication stages of the
Once a schema proposal is Approved, its changes need to be implemented.
For those implementing the changes,
Once the changes are implemented, you can use schema checks to ensure your organization only
Pull proposed schemas with Rover
The rover subgraph fetch command
rover subgraph fetch my-graph@p-101 --name subgraph
A proposal's ID is always prefixed with p- and followed by a number. You can find the proposal ID in the proposal's URL in p-101.
https://studio.apollographql.com/graph/Example-supergraph/proposal/p-101/home
ⓘ NOTE
You can't push schema changes to proposals with the rover subgraph publish command.
Validate changes with checks
GraphOS provides
Since schema checks
Ensure changes match an approved proposal
You can
Configuring the Proposals task's severity to Error ensures that only changes approved through the proposal process can be published. By setting the severity to Warning you can publish changes that haven't been approved and receive warnings about them.
ⓘ NOTE
The Proposals task also checks descriptions in the SDL. For example, the Proposals task fails if a matching approved proposal includes a description with a period and the change the check is running on doesn't.
When a check with the Proposals task runs, you can see which changes match a proposal by clicking the Proposals task on the Checks page:
- Changes with matching approved proposals show checkmark icons.
- Changes without matching approved proposals show warning or error icons depending on the configured severity.
Clicking the icons reveals a list of matching proposals in the right panel. Click Ignore to allow the Proposals task to succeed without matching approved proposals for all changes.
Matching changes to proposals
Incoming changes and approved proposals don't need to match one-to-one. For example, suppose you have an approved proposal with changes in multiple subgraphs. You can check each subgraph's changes separately. Each subgraph check still passes even though the change doesn't encompass all the approved proposal's changes.
Similarly, a single proposal can contain a large change in one subgraph that you want to divide into multiple checks. Those changes can match across multiple checks and each check passes.
Publish changes to GraphOS
Once you've implemented the approved schema changes, including supporting code, you need to publish the subgraph schemas back to GraphOS. Publishing schema proposal changes follows the same
When a subgraph schema published to a proposal's source variant contains changes that are in an Approved, Open for Feedback, or Draft proposal, the corresponding
When an Approved or Open for feedback proposal's changes have been fully implemented—
ⓘ NOTE
- A proposal with Draft status can't become Implemented, even when all its changes are published. Once such a proposal's status is changed to Open for feedback, it automatically switches to Implemented.
- Implemented proposals can't receive further revisions, nor their status be changed.