Manual exceptions

[xmulligan]

Is there a way to to manually override the checks? For instance at Cilium https://clomonitor.io/projects/cilium/cilium

We have a a USERS.md rather than ADOPTERS.md https://github.com/cilium/cilium/blob/master/USERS.md

and our governance file is in the documentation folder which wasn't part of the scan https://github.com/cilium/cilium/blob/master/Documentation/contributing/governance/commit_access.rst

[xmulligan]

and we also have the changelog with each release notes https://github.com/cilium/cilium/releases/tag/v1.11.2

[tegioz]

Hi @xmulligan 👋

There isn't any way to override locations for checks yet, but it's something we are considering. We recently introduced the .clomonitor.yml metadata file that we could extend for this purpose.

In addition to detecting the the ADOPTERS.md file, we also check if an Adopters header is present in the README.md. If adding a minimal section to your readme file pointing users to the USERS.md file sounds like a good option, it should do the trick 🙂 The Kubernetes project has handled it this way, for example. This works for some more checks, including Governance.

[tegioz]

Regarding the changelog check, we are actually checking the notes of the last release looking for this pattern (?i)changelog. Maybe we could also check for an additional pattern with changes in a header title 🤔 The trick mentioned above would work for the changelog check as well though.

[caniszczyk]

for the ADOPTERS.md check, I think we should check for ADOPTERS.md or USERS.md @tegioz and just build that into the check

[tegioz]

for the ADOPTERS.md check, I think we should check for ADOPTERS.md or USERS.md @tegioz and just build that into the check

Done 👍

[xmulligan]

Thanks for the help! We are going to do something similar to Kubernetes see cilium/cilium#19037

[tegioz]

I've just realized that your README file uses reStructured text, not markdown. At the moment we only support detecting those headers in markdown files @xmulligan.

[tegioz]

The regular expressions we are using for headers look for the hash symbols used in markdown headers (IIRC headers in reStructured text are different). But I think maybe we could also accept those words (Governance, etc) when they appear at the beginning of a line and it's the only word on it. That should make it work for this case and it's generic enough to be ok.

I'm finishing something but as soon as I'm done I'll take a look at this, will keep you posted 👍

[tegioz]

It's done @xmulligan, we should be able to detect those headers in README files using reStructured text 🙂

Will deploy it within the next hour 🚀

[xmulligan]

Thanks @tegioz ❤️ really appreciate all the help 💯

[tegioz]

No worries! 😊👋

[xmulligan]

ok, sorry same question about the slack now 😅 We have been approved to keep the Cilium + eBPF slack separate from the CNCF or K8s slack. What can we do to meet the requirement?

[tegioz]

Hi @xmulligan

We have a few options to handle this:

• You could wait until support for checks exemptions is ready (Consider supporting checks exemptions #154), which would allow you to skip this one.

• We could relax a bit the Slack check and accept other workspaces as well as headers in the README file. Not sure if this is an option though. What do you think @jeefy? (check requested in Check for Slack Presence #129)

[caniszczyk]

I'd like to not encourage other Slacks outside of k8s/CNCF so let's just wait for exemptions atm

…

On Fri, Mar 18, 2022 at 9:20 AM Sergio C. Arteaga ***@***.***> wrote: Hi @xmulligan <https://github.com/xmulligan> We have a few options to handle this: - You could wait until support for checks exemptions is ready (#154 <#154>), which would allow you to skip this one. - We could relax a bit the Slack check and accept other workspaces as well as headers in the README file. Not sure if this is an option though. What do you think @jeefy <https://github.com/jeefy>? (check requested in #129 <#129>) — Reply to this email directly, view it on GitHub <#120 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPSIITNLI4DWIH5VXOOUDVASGL3ANCNFSM5P2HVIPA> . You are receiving this because you commented.Message ID: ***@***.***>

-- Cheers, Chris Aniszczyk https://aniszczyk.org

[tegioz]

Ok, cool 👍

Will close this issue in favor of #154 @xmulligan. You'll be able to add an exemption for this check as soon as #154 is ready.

[tegioz]

Support for exemptions is ready @xmulligan. Please see the checks document for more details.

[xmulligan]

Thanks for the help, I've opened cilium/cilium#19235 to cover this 💯