-
Notifications
You must be signed in to change notification settings - Fork 118
Add data migration capability for configs #643
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
Merged
Merged
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
60424dc to
9c9db65
Compare
a779301 to
e5d810c
Compare
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.
Adds a full fledged migration engine for custom configurations. Previously I had a full changelog, but it'll be more useful to read the new migrations README in this PR.
https://github.com/MLB-LED-Scoreboard/mlb-led-scoreboard/blob/24de6ae98498cb625ba0a8e3058d53ded1dbf7ff/migrations/README.md
This PR is huge, but it's mostly machinery. Actually using the migrator is a much simpler pattern than trying to extend our existing recursive config validator (although we still need to keep the validator itself), or just having to put out a deprecation warning.
Once this work is done it significantly lessens the risk of the planned v9.0.0 breaking update coming with #604
High level:
python -m migrations init/generate/up/down/subconfigtxnobject instead of directly opening a file--configon script boot. If located in the right directory and with the right name, we can add that to the migration system. Also planning to do that with the validator, but it's not in this PR..example.jsonto.schema.json, maybe it'll discourage people from editing themschemafiles to their corresponding custom files. No need tocpby hand. Migrations are also run during the installation as well.The big config migration that was planned is already in place. I'm planning to revert the config changes introduced in that PR (possibly as a separate PR). Then I will write the migrations that generate those configs, and we'll know that the migration system is expressive enough to work for the task.