chore: ensure all config variables are in both config files #689
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fad28f0 to
d8b805b
Compare
config.devel.php was missing some config setting that were present in config.dist.php. This caused some failures. In particular the missing 'enforce.custom.mail.template' setting caused a failure. Also add a CI check to make sure the config files stay in sync. It does not require the values are in sync but that all settings are defined in both files. Also fix two typos.
d8b805b to
4867bff
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR ensures that config.devel.php includes all settings from config.dist.php by adding the missing enforce.custom.mail.template key, fixes a minor typo in a comment, and introduces a CI check to keep both config files in sync.
- Added a new
config-checkTox environment and CI step to compare keys in both config files. - Updated
config.dist.phpto correct a typo in the comment forenforce.custom.mail.template. - Synchronized
config.devel.phpby adding the missing setting and several development-only defaults.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tox.ini | Added config-check env and included it in the envlist. |
| config/config.dist.php | Corrected typo in the enforce.custom.mail.template comment. |
| config/config.devel.php | Added missing enforce.custom.mail.template and other dev-only settings. |
| ci/config-check.py | New script to verify both config files define the same keys. |
| .github/workflows/lint-and-analyse-php.yml | Added a tox -e config-check step to the CI workflow. |
Comments suppressed due to low confidence (3)
config/config.devel.php:218
- The comment for hide.position incorrectly references the phone field; it should mention the position requirement instead.
$conf['settings']['registration']['hide.position'] = 'false'; //Hide position field when 'true', but show it when the phone is required
config/config.devel.php:219
- The comment for hide.organization incorrectly references the phone field; it should mention the organization requirement instead.
$conf['settings']['registration']['hide.organization'] = 'false'; //Hide organization field when 'true', but show it when the phone is required
ci/config-check.py:21
- The CI script compares all config keys between dist and devel but does not exclude dev-only settings (e.g., authentication and delete.old.data sections), causing the check to fail; consider adding an ignore list or filtering logic for dev-specific keys.
missing_devel = dist_configs - devel_configs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
config.devel.php was missing some config setting that were present in config.dist.php. This caused some failures.
In particular the missing 'enforce.custom.mail.template' setting caused a failure.
Also add a CI check to make sure the config files stay in sync. It does not require the values are in sync but that all settings are defined in both files.