-
Notifications
You must be signed in to change notification settings - Fork 21
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
ci: complain about catch-alls documenting alarm (sub) codes #280
base: main
Are you sure you want to change the base?
ci: complain about catch-alls documenting alarm (sub) codes #280
Conversation
Facilitate figuring out *which* alarm is only documented by a catch-all.
Context: #279 (specifically: #279 (comment)). @ted-miller: turns out I'd already added the possibility to emit warnings about catch-all ranges in the documentation, we just hadn't enabled it during the CI run. This enables it and slightly improves the warning text to also include the specific alarm (sub) code which is covered by a catch-all. Note: unfortunately we have quite a few alarms documented by catch-alls, and the run summary only shows up to 10. |
Friendly ping @ted-miller |
Are you sure we want this then? If there are other warnings, would they get smothered by this message? |
so, yes, I would want this, but perhaps the script that checks these things should be extended to allow for ignoring certain alarm ranges/IDs. |
Ok. It's fine with me then.
Not sure why you switched back to a Draft PR. Are you making such a change? |
yeah, I'll add it. |
This won't mark the job as failed, but it will result in annotations being added to a PR or CI run.
Example:
Edit: and on a PR we'd get:
But only the first 10 warnings.