Skip to content
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

Flank YAML backwards compatibility #515

bootstraponline opened this Issue Mar 11, 2019 · 1 comment


2 participants
Copy link

bootstraponline commented Mar 11, 2019

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


  • 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

This comment has been minimized.

Copy link

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 bootstraponline changed the title Backwards compatability Flank YAML backwards compatibility Mar 13, 2019

Flank v5 automation moved this from In progress to Done Mar 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.