-
Notifications
You must be signed in to change notification settings - Fork 107
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
docs: static breaking change threshold product update #6287
Merged
Merged
Changes from all commits
Commits
Show all changes
4 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
Binary file added
BIN
+85.9 KB
...es/web/docs/public/changelog/2025-01-10-static-breaking-change-threshold/ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-120 KB
(42%)
...s/web/docs/public/docs/pages/management/target-conditional-breaking-changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
This file contains 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
26 changes: 26 additions & 0 deletions
26
.../docs/src/pages/product-updates/2025-01-10-static-breaking-change-threshold.mdx
This file contains 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,26 @@ | ||
--- | ||
title: Added a Conditional Breaking Change Static Threshold | ||
description: | ||
A minor improvement to our conditional breaking changes behavior that allows changes to be | ||
considered breaking based on a minimum number of requests. | ||
date: 2025-01-10 | ||
authors: [jdolle] | ||
--- | ||
|
||
Expect a lot of improvements to the Hive Schema Registry in 2025. | ||
|
||
One of the first updates this year is a small but potentially very useful option for | ||
[Conditional Breaking Changes](https://the-guild.dev/graphql/hive/docs/management/targets#conditional-breaking-changes). | ||
Previously, Conditional Breaking Changes checked compatibility against all operations called in the | ||
past number of days. If the percent impacted exceeded the configured percentage threshold, then the | ||
change would be considered breaking. Unfortunately for schemas with disproportionate operation | ||
usage, an operation with very little percent usage could still have a major impact to their | ||
consumers. | ||
|
||
To better handle this case, a new option has been added to set a static threshold for the total | ||
number of operations that can be incompatible before the change is considered breaking. | ||
|
||
![Breaking Changes UI](/changelog/2025-01-10-static-breaking-change-threshold/ui.png) | ||
|
||
So if you were using a 0% threshold but found it a bit too restrictive, considered this new option | ||
to set a higher static threshold. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is me being picky.
Correct me if I'm wrong -- but I think "compatibility" is the technical definition for the spec and "breaking" is the notion of how that compatibility impacts real clients.