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.

Sign up for GitHub

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

Jump to bottom

Flank YAML backwards compatibility #515

Closed

bootstraponline opened this issue Mar 11, 2019 · 1 comment · Fixed by #518

Assignees

Labels

Contributor

bootstraponline commented Mar 11, 2019 •

edited

Loading

Flank is a mature enough project where a backwards compatibility strategy is necessary to avoid breaking users as changes are made.

Ideas

Print to log when deprecated keys are used
Support legacy key names until the next major release
Auto rewrite YAML file to use the new keys (either automatically or on demand via doctor command)

If a user has a legacy key name that's no longer supported, what should we do?

Exit with an with an error message?
Auto rewrite YAML to the new key name (if auto migration is possible)?
Continue to run but ignore the key and print a warning to standard out

Out of scope

CLI flags are not part of the backwards compatibility commitment

bootstraponline added 5 Tech Debt labels

bootstraponline mentioned this issue

Fixes #490 Rename testShards to maxTestShards #514

Merged

bootstraponline self-assigned this

Contributor

valeraz commented Mar 11, 2019

I would go with:

deprecation warning on console
support for legacy functionality for 1 major release
on-demand fixing of the configs (as opposed to automatic)
exiting with an error message once the legacy value is no longer supported

bootstraponline changed the title ~~Backwards compatability~~ Flank YAML backwards compatibility

bootstraponline mentioned this issue

Auto migrate YAML changes #518

Merged

bootstraponline closed this as completed in #518

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment