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

Stability: Configuration file #393

Closed
hug-dev opened this issue Apr 14, 2021 · 2 comments
Closed

Stability: Configuration file #393

hug-dev opened this issue Apr 14, 2021 · 2 comments
Assignees
Labels
stability Issues related to the stability of the service

Comments

@hug-dev
Copy link
Member

hug-dev commented Apr 14, 2021

Definition: Old configuration files should still work with future stable Parsec versions, with the same default for optional options.
Enforcement: Configuration options should not disappear in future stable Parsec versions. Configuration defaults should remain the same. New options should be optional.

Enforcement Check

This can only be done through testing/code review. The config file contains its own documentation regarding field description and defaults.
The Parsec Configuration page could maybe be used to formalize that? But that is duplication of information.

Warning could maybe be set in the code as comments, or in the CI when those parts are modified? If they are put in their own files we can specifically check when the file is modified.

Testing

All the options in the config.toml file should be tested and verified accross different Parsec versions. That includes the "behaviour" of some fields. Defaults should be checked as well.

@hug-dev hug-dev added the stability Issues related to the stability of the service label Apr 14, 2021
@hug-dev
Copy link
Member Author

hug-dev commented Apr 20, 2021

Could use similar way as described in #382: put all config structures in one file that is code owned.
All possible options and defaults should be checked in config tests for every PR.

@hug-dev
Copy link
Member Author

hug-dev commented May 19, 2021

Updated in the book in parallaxsecond/parsec-book#121

@hug-dev hug-dev closed this as completed May 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stability Issues related to the stability of the service
Projects
None yet
Development

No branches or pull requests

1 participant