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

ci: complain about catch-alls documenting alarm (sub) codes #280

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gavanderhoorn
Copy link
Collaborator

@gavanderhoorn gavanderhoorn commented Jul 17, 2024

This won't mark the job as failed, but it will result in annotations being added to a PR or CI run.

Example:

image


Edit: and on a PR we'd get:

image

But only the first 10 warnings.

@gavanderhoorn
Copy link
Collaborator Author

gavanderhoorn commented Jul 17, 2024

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.

@gavanderhoorn
Copy link
Collaborator Author

Friendly ping @ted-miller

@ted-miller
Copy link
Collaborator

unfortunately we have quite a few alarms documented by catch-alls, and the run summary only shows up to 10.

Are you sure we want this then? If there are other warnings, would they get smothered by this message?

@gavanderhoorn
Copy link
Collaborator Author

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.

@gavanderhoorn gavanderhoorn marked this pull request as draft July 29, 2024 15:04
@ted-miller
Copy link
Collaborator

Ok. It's fine with me then.

but perhaps the script that checks these things should be extended to allow for ignoring certain alarm ranges/IDs

Not sure why you switched back to a Draft PR. Are you making such a change?

@gavanderhoorn
Copy link
Collaborator Author

Are you making such a change?

yeah, I'll add it.

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 this pull request may close these issues.

2 participants