Migrate settings to the declarative v1.13.0 format - #3
Open
zormit wants to merge 3 commits into
Open
Conversation
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
1 participant
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.
Following the guide, I first tried support multiple version (Path B). But the code for this is quite ugly, see bd37ce0 and it seems that it's not really worth it: We can probably assume the auto-updater is working well enough and almost everyone is on the newest version anyways. I tried to clarify this assumption on Discord and they said it should be ok as long as we correctly set the
minAppVersion.As for how to solve it in the new declarative format, I struggled with mapping our config. The main problem seems to be that we want to configure instances, which are a list of complex configurations ("groups"). The declarative approach has lists, which in my testing only worked with singular setting objects, not groups. Also tried to consult the Discord on that without success so far.
So I chose to render a new page as described here. Would be curious if you find another approach that works, but I think a page is okay. The downside is that your tutorial is outdated and that the configuration is a bit more nested.
One thing we could consider going forward (independently of this migration) is to provide the flagship instance as a pre-defined default instance, so that the plugin works "off the shelf".