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

Introduce configuration versioning #203

Open
andre-stefanov opened this issue Nov 26, 2022 · 0 comments · Fixed by #205
Open

Introduce configuration versioning #203

andre-stefanov opened this issue Nov 26, 2022 · 0 comments · Fixed by #205
Labels
enhancement New feature or request

Comments

@andre-stefanov
Copy link
Member

we should add a version value to each generated local config, e.g:

#define LOCAL_CONFIG_VERSION 1

the firmware code could then have following definition & check:

#define MIN_LOCAL_CONFIG_VERSION 1
#if MIN_LOCAL_CONFIG_VERSION > LOCAL_CONFIG_VERSION
  #error You have to update your local config to be able to use this version of firmware
#endif

This would allow us making changes to the config api (e.g. renaming or restructuring the config definitions) which would not lead to compile errors otherwise.
The user would also have an easier to understand error message instead of some generic "XYZ not defined"
If we introduce some breaking changes, we simply bump the min required config version in the firmware ... then adapt the config server and bump the version there as well.

@andre-stefanov andre-stefanov added the enhancement New feature or request label Nov 26, 2022
@andre-stefanov andre-stefanov linked a pull request Nov 30, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant