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

Validate app.ini about deprecated options #6498

Open
mrkeuz opened this issue Feb 10, 2021 · 1 comment · May be fixed by #7705
Open

Validate app.ini about deprecated options #6498

mrkeuz opened this issue Feb 10, 2021 · 1 comment · May be fixed by #7705

Comments

@mrkeuz
Copy link

mrkeuz commented Feb 10, 2021

Describe the feature

It would be good to show some warning about DEPRECATION configs in app.ini.

Just faced with next issue. I rename [mailer][email] section in app.ini and email stopping work. After quick check, I find that PASSWD field was renamed to PASSWORD and it has not any records in CHANGELOG.md about this. Only about section rename.

So it will be good validate app.ini to some deprecated/unused option. Or at least warn about unused option for quickly validate successfully migration.

Also, this will avoid errors in the configuration and unnecessary issues on GitHub.

NOTE: Some options may be security importance so if some of them will silent back to default it can be potential risky.

Describe the solution you'd like

Make some schema for validation app.ini file and validate that all parameters are valid and applied. If not, show notification at start.

Describe alternatives you've considered

  • Make just list of acceptable section→parameter pairs. Can be extracted in automatic manner from orig app.ini. So without deprecation detection.
  • Validate current app.ini at least that all option actual.
  • Show warnings at start that section→parameter deprecated or unused.
  • Show warning if section renamed (exist only in orig app.ini)

Proof of concept: https://gist.github.com/mrkeuz/b200dc626531de60d98f625b2aff63c1

Additional context

@AndreasPantle
Copy link

Full ack. I was updating my installation and run into similar problems... Now the only chance is to compare the local app.ini with the one in the tag.

@pikomonde pikomonde linked a pull request Mar 26, 2024 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants