-
Notifications
You must be signed in to change notification settings - Fork 124
docs: conditional breaking changes based on app deployments product update #7401
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
adambenhassen
wants to merge
3
commits into
main
Choose a base branch
from
adam/console-1276-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
...duct-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: Schema Checks Show Affected App Deployments | ||
| description: | ||
| See which app deployments would be impacted by breaking schema changes before deploying. | ||
| date: 2025-12-10 | ||
| authors: [adam] | ||
| --- | ||
|
|
||
| Schema checks now show which active app deployments would be affected by breaking changes, helping | ||
| you understand the real-world impact before deploying schema updates. | ||
|
|
||
| ## How It Works | ||
|
|
||
| When a schema check detects breaking changes, Hive automatically identifies which active app | ||
| deployments have operations that use the affected schema coordinates. For each affected deployment, | ||
| you'll see: | ||
|
|
||
| - The app deployment name and version | ||
| - Which specific operations within that deployment use the affected fields | ||
|
|
||
| ## Example | ||
|
|
||
| If you're removing `Query.users`, and your `[email protected]` deployment has operations that query | ||
| this field, the schema check will show: | ||
|
|
||
| - **Breaking change**: Field `users` was removed from object type `Query` | ||
| - **Affected deployment**: `mobile-app` version `2.1.0` | ||
| - **Affected operations**: The specific operation names and hashes that use this field | ||
|
|
||
| ## Benefits | ||
|
|
||
| - **Impact assessment**: Understand which client applications would break before deploying | ||
| - **Team coordination**: Know which teams need to update their apps before proceeding | ||
| - **Risk mitigation**: Make informed decisions about breaking changes | ||
|
|
||
| Only **active** app deployments (published and not retired) are analyzed. Pending and retired | ||
| deployments are not included. | ||
|
|
||
| --- | ||
|
|
||
| - [Learn more about App Deployments](/docs/schema-registry/app-deployments#schema-checks-and-affected-app-deployments) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -258,6 +258,50 @@ change to **retired**. | |
|
|
||
| - [`app:retire` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-appretire) | ||
|
|
||
| ## Schema Checks and Affected App Deployments | ||
|
|
||
| When you run a schema check that detects breaking changes, Hive automatically identifies which | ||
| active app deployments would be affected by those changes. This helps you understand the real-world | ||
| impact of schema changes before deploying them. | ||
|
|
||
| ### How It Works | ||
|
|
||
| During a schema check, Hive analyzes the breaking changes and matches them against the persisted | ||
| documents in your active app deployments. Hive identifies all app deployments that have operations | ||
| using any of the affected schema coordinates (e.g., fields like `Query.hello` that are being | ||
| removed). | ||
|
|
||
| For each affected app deployment, you'll see: | ||
|
|
||
| - **The deployment** name and version | ||
| - **Which specific operations** within that deployment use the affected schema coordinates | ||
|
|
||
| This information is displayed alongside the breaking changes in the schema check results, helping | ||
| you understand the collective impact across all your active app deployments. | ||
|
|
||
| ### Example | ||
|
|
||
| If you have a breaking change that removes the `Query.users` field, and you have an active app | ||
| deployment `[email protected]` with operations that query `Query.users`, the schema check will show: | ||
|
|
||
| - The breaking change: "Field 'users' was removed from object type 'Query'" | ||
| - Affected app deployment: `mobile-app` version `2.1.0` | ||
| - Affected operations: The specific operation names and hashes that use this field | ||
adambenhassen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Benefits | ||
|
|
||
| - **Impact assessment**: Understand which client applications would break before deploying schema | ||
| changes | ||
| - **Coordination**: Know which teams need to update their apps before a breaking change can be | ||
| safely deployed | ||
| - **Risk mitigation**: Make informed decisions about whether to proceed with breaking changes or | ||
| find alternative approaches | ||
|
|
||
| <Callout type="info"> | ||
| Only **active** app deployments (published and not retired) are checked for affected operations. | ||
| Pending and retired deployments are not included in this analysis. | ||
| </Callout> | ||
|
|
||
| ## Persisted Documents on GraphQL Server and Gateway | ||
|
|
||
| Persisted documents can be used on your GraphQL server or Gateway to reduce the payload size of your | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.