chore(docs): clarify some breaking changes in v10 - #368
Merged
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| `GradualRolloutRandomStrategy`, `GradualRolloutUserWithIdStrategy`, and | ||
| `GradualRolloutSessionIdStrategy`) are no longer part of the Java SDK public API in v10. | ||
|
|
||
| These strategies are evaluated internally by Yggdrasil. There is no class-for-class replacement to import for built-ins; use the built-ins via Unleash configuration, and implement `Strategy` only for custom or fallback behavior. |
There was a problem hiding this comment.
“use the built-ins via Unleash configuration” is ambiguous in this repo because “configuration” often refers to UnleashConfig (SDK-side). Consider clarifying that built-in strategies are selected/configured on the Unleash server/UI (i.e., by strategy name in feature flag definitions), not by importing Java classes.
Suggested change
| These strategies are evaluated internally by Yggdrasil. There is no class-for-class replacement to import for built-ins; use the built-ins via Unleash configuration, and implement `Strategy` only for custom or fallback behavior. | |
| These strategies are evaluated internally by Yggdrasil. There is no class-for-class replacement to import for built-ins in the Java SDK; to use these built-ins, select the corresponding built-in strategy names when configuring your feature flags in the Unleash server/UI, and implement `Strategy` only for custom or fallback behavior in your own code. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clarify breaking changes and add details to the migration guide.
Closes #367