You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Abby C pointed out taht we risk qiskit_bot.yaml becoming stale, such as when we add new pages or rename pages. So, we should have a new check that ensures every non-API file has an owner in qiskit_bot.yaml.
Of course, some pages don't need owners, so there should be an allowlist mechanism. You have to explicitly opt-in to this allowlist. The default behavior is to error if the file has no owners.
The error message should explain well what the options are: adding an owner or allow-listing. It should account for the possibility the file has been renamed vs. new file.
Implementation will be similar to the orphan page check.
The text was updated successfully, but these errors were encountered:
Closes#1330
This PR adds a check for the qiskit bot config to avoid the
`qiskit_bot.yaml` becoming stale.
The check shows two lists of files that can lead to an error:
The first one is for files that exist in the repo but don't have any
entry in the qiskit bot entry. This case will be triggered when we add
new files or we rename old ones without changing the configuration. If
we don't want to track a new file, we can add its path to the
`ALLOWED_OWNERLESS_FILES` set to avoid the error message.
The second list of files are the ones that don't exist in the repo but
have an entry in the config file. This case will be triggered by files
that change their name, removed files with the entry as a leftover, or
files where we set the config beforehand. The last ones can be added to
the `ALLOWED_INEXISTENT_FILES` set to avoid the error message.
The renamed files trigger both errors and will show the old name in the
first list, and the new name in the second one. This could be useful to
identify the old entries in the config file and to associate the files
in case we have multiple errors.
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Abby C pointed out taht we risk qiskit_bot.yaml becoming stale, such as when we add new pages or rename pages. So, we should have a new check that ensures every non-API file has an owner in qiskit_bot.yaml.
Of course, some pages don't need owners, so there should be an allowlist mechanism. You have to explicitly opt-in to this allowlist. The default behavior is to error if the file has no owners.
The error message should explain well what the options are: adding an owner or allow-listing. It should account for the possibility the file has been renamed vs. new file.
Implementation will be similar to the orphan page check.
The text was updated successfully, but these errors were encountered: