From d403a0e2591697f8115e106d334e8d76772274ed Mon Sep 17 00:00:00 2001 From: Adam Benhassen Date: Mon, 8 Dec 2025 14:43:03 +0100 Subject: [PATCH 1/3] add docs --- .../schema-registry/app-deployments.mdx | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/packages/web/docs/src/content/schema-registry/app-deployments.mdx b/packages/web/docs/src/content/schema-registry/app-deployments.mdx index 91f45a5b99..1e8ed50933 100644 --- a/packages/web/docs/src/content/schema-registry/app-deployments.mdx +++ b/packages/web/docs/src/content/schema-registry/app-deployments.mdx @@ -258,6 +258,49 @@ 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 `mobile-app@2.1.0` 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 + +### 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 + + + Only **active** app deployments (published and not retired) are checked for affected operations. + Pending and retired deployments are not included in this analysis. + + ## 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 From dbe5ff871dfeee5828c9ffa41777b6aa863df2af Mon Sep 17 00:00:00 2001 From: Adam Benhassen Date: Wed, 10 Dec 2025 13:11:43 +0100 Subject: [PATCH 2/3] add product page --- .../page.mdx | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx diff --git a/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx b/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx new file mode 100644 index 0000000000..1f3e9f5cb9 --- /dev/null +++ b/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx @@ -0,0 +1,40 @@ +--- +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 `mobile-app@2.1.0` 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) From 676b775dfde96ba0d45648467aff344223162821 Mon Sep 17 00:00:00 2001 From: Adam Benhassen Date: Tue, 16 Dec 2025 18:39:23 +0100 Subject: [PATCH 3/3] prettier fixes --- .../page.mdx | 3 ++- .../docs/src/content/schema-registry/app-deployments.mdx | 9 +++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx b/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx index 1f3e9f5cb9..48e421b956 100644 --- a/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx +++ b/packages/web/docs/src/app/product-updates/(posts)/2025-12-10-schema-checks-affected-app-deployments/page.mdx @@ -1,6 +1,7 @@ --- title: Schema Checks Show Affected App Deployments -description: See which app deployments would be impacted by breaking schema changes before deploying. +description: + See which app deployments would be impacted by breaking schema changes before deploying. date: 2025-12-10 authors: [adam] --- diff --git a/packages/web/docs/src/content/schema-registry/app-deployments.mdx b/packages/web/docs/src/content/schema-registry/app-deployments.mdx index 1e8ed50933..6ed4d15f39 100644 --- a/packages/web/docs/src/content/schema-registry/app-deployments.mdx +++ b/packages/web/docs/src/content/schema-registry/app-deployments.mdx @@ -260,15 +260,16 @@ change to **retired**. ## 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. +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). +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: