docs: info about migrating to v6 #206
Merged
Conversation
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
Pull Request Test Coverage Report for Build 11054316958Details
💛 - Coveralls |
gastonfournier
approved these changes
Sep 26, 2024
v6_MIGRATION_GUIDE.md
Outdated
| @@ -0,0 +1,39 @@ | |||
| # Migrating to Unleash-Client-Ruby 6.0.0 | |||
|
|
|||
| The upgrade the v6.0.0 of the Unleash client should be mostly seamless. There are a few significant changes that may require some changes on the consumer side or that the consumer should be generally aware of. | |||
There was a problem hiding this comment.
Suggested change
| The upgrade the v6.0.0 of the Unleash client should be mostly seamless. There are a few significant changes that may require some changes on the consumer side or that the consumer should be generally aware of. | |
| The upgrade of Unleash client to v6.0.0 should be mostly seamless. But if you have extended or modified the SDK, there are a few things that may require changes on the consumer side or that the consumer should be aware of. |
v6_MIGRATION_GUIDE.md
Outdated
Comment on lines
11
to
27
| Secondly, the deprecated `register_custom_strategies` method has now been removed. The only way to register a custom strategy is to use configuration, i.e. | ||
|
|
||
| ```ruby | ||
| class MyCustomStrategy | ||
| def name | ||
| 'myCustomStrategy' | ||
| end | ||
|
|
||
| def is_enabled?(params = {}, context = nil) | ||
| true | ||
| end | ||
| end | ||
|
|
||
| Unleash.configure do |config| | ||
| config.strategies.add(MyCustomStrategy.new) | ||
| end | ||
| ``` |
There was a problem hiding this comment.
This is the same as our documentation on the readme. I'm thinking if adding the snippet here adds value or if we can just link to the readme. The downside of having the snippet is that people skimming through these docs may think there's a bunch o changes, but actually, we expect users to already be doing this.
v6_MIGRATION_GUIDE.md
Outdated
| end | ||
| ``` | ||
|
|
||
| If you're already using configuration to register your custom strategies and you're not overriding the default strategies, this section doesn't affect you. |
There was a problem hiding this comment.
Maybe this should be at the beginning of this section as a bold note.
melindafekete
approved these changes
Sep 26, 2024
sighphyre
commented
Sep 26, 2024
Co-authored-by: Gastón Fournier <[email protected]>
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.
Migration guide for moving to v6. Turns out evaluations between Yggdrasil base and the Ruby SDK are already identical insofar as I can tell so no changes there
For Discussion
I expected the change set to be a lot larger so I broke this into its own file but now that I'm looking at it, it's less than I expected. Could/should this just be part of the main README?