The code owners functionality relies on the validity of the following:
@PLUGIN@
pluginTo reduce the risk that these files become invalid, they are validated when they are modified and invalid modifications are rejected. In addition code owner config files in a repository can be validated on demand by the Check code owners files REST endpoint.
NOTE: Most configuration issues are gracefully handled and do not break the code owners functionality (e.g. non-resolveable code owners or non-resolveable imports are silently ignored), however some configuration issue (non-parseable configuration files, configuration of a non-existing backend etc.) are severe errors and block the submission of all changes for which the affected configuration files are relevant.
NOTE: It's possible to disable the validation of code owner config files on push and setup an external validation by a CI bot instead. In this case findings would be posted on the change.
All validations are best effort to prevent invalid configurations from entering the repository, but not all possible issues can be prevented. Doing the validation is useful since it prevents most issues and also gives quick feedback to uploaders about typos (e.g. if an email is misspelled it's not breaking anything, but the intended change of the uploader is not working).
No validation is done when:
@PLUGIN@
plugin is not installed/enabled (this means when the @PLUGIN@
plugin gets installed/enabled, it is possible that invalid configuration files already exist in the repository)In addition for code owner config files no validation is done when:
@PLUGIN@
plugin configuration is invalid (in this case we don't know which files are code owner config files, so we allow all uploads rather than blocking all uploads, to reduce the risk of breaking the plugin configuration code-owner.config
files are validated too)In addition it is possible that code owner config files get issues after they have been submitted:
When updating code owner config files the validation only rejects the update if it introduces new issues. This means the update is allowed if:
For code owner config files the validation is also performed on submit (in addition to the validation that is performed on upload of the change). This is because relevant configuration can change between the time a change is uploaded and the time a change is submitted. On submit we repeat the exact same validation that was done on upload. This means, all visibility checks will be done from the perspective of the uploader.
For code owner config files the following checks are performed:
HIDDEN
)The following things are not checked (not an exhaustive list):
For the code-owner.config in the refs/meta/config
branch the following checks are performed:
code-owner.config
file is parseableBack to @PLUGIN@ documentation index
Part of Gerrit Code Review