Proposals - WunderGraph Hub
What are Proposals?
Proposals provide a structured way to manage, review, and implement changes to federated graphs. They allow teams to propose and evaluate modifications to subgraphs, enabling a collaborative review process and minimizing the risk of introducing errors or breaking changes. A proposal represents a collection of changes to a federated graph, which can include:
- Updates to existing subgraphs
- Addition of new subgraphs
- Removal of existing subgraphs
Required configuration
To use proposals, the user should have integrated the graph with the WunderGraph Cosmo schema registry. Once the graph is integrated, the users should configure proposals on Cosmo. Click here to learn more about how to configure proposals on Cosmo.
How to create a proposal?
To create a proposal, follow these steps:
Make changes to the schema in a fork of the main branch.
Navigate to the "Proposal" tab and click on the "Create Proposal" button.
Select the collections you want to analyze.
The operations in the collections will be analyzed for performance and complexity. The selection of collections is optional but recommended. 4. Click on the "Create Proposal" button.
Proposal Workflow
The typical workflow for proposals includes:
Creation
A team member creates a fork of the main branch, makes changes to the schema and then creates a proposal.
Validation
Automatic checks are run to validate the proposal for:
- Composition errors
- Breaking changes
- Operation impact (based on actual usage data)
- Lint errors
- Graph pruning errors
Review
Team members can review the proposal.
Collaboration
Team members discuss and refine the proposal if needed.
Decision
Approving or closing the proposal based on review.
Application
Applying approved proposals to update the federated graph.
Proposal States
Proposals go through various states during their lifecycle:
| State | Description |
|---|---|
| Draft | It’s the initial state when the proposal is created and is not yet reviewed. |
| Open | Indicates that the proposal is open for review. |
| Approved | Indicates that the proposal has been approved by authorized team members. |
| Published | Indicates that all the subgraphs which are part of the proposal have been published. |
| Closed | Indicates that the proposal has been closed. |
Why Use Proposals?
Proposals help teams:
- Collaborate on schema evolution: Enables team members to review and approve changes.
- Document schema changes: Keeps a historical record of modifications to your graph.
- Enforce governance: Implements proper change management for your GraphQL architecture.
- Prevent breaking changes: Identifies and addresses potential issues before they impact users.