cncf / clomonitor

CLOMonitor is a tool that periodically checks open source projects repositories to verify they meet certain project health best practices
https://clomonitor.io
Apache License 2.0
111 stars 73 forks source link

Trademark link not recognized #1326

Closed chalin closed 10 months ago

chalin commented 11 months ago

I recently added to the OTel website a link to the LF trademark page. If I used the first regex from the CLOmonitor docs, I get a match:

$ curl -s https://opentelemetry.io | perl -ne 'print if /https:\/\/(?:www\.)?linuxfoundation\.org\/(?:legal\/)?trademark-usage/' | wc -l
       1

But legal is still marked as unmatched, see https://clomonitor.io/projects/cncf/open-telemetry#community_legal:

image

What am I missing? Thanks!

/cc @svrnm @nate-double-u

tegioz commented 11 months ago

Hi @chalin 👋

The CLOMonitor tracker runs every hour and processes a repository when:

In this case, the OTel community repo last change was 2 days ago, which means it'll be processed once a day until it changes again. The last time it was processed was 2023-10-18 15:01:07.377759+00, but you committed the trademark change shortly after (24 mins), at Wed Oct 18 11:25:22 2023 -0400 (plus the time it took to deploy it). So by the time the repository was processed, the trademark wasn't there yet.

If this is correct it should be fixed automatically in less than 5 hours (unless something is committed to the community repository before) 😇

chalin commented 11 months ago

That makes sense, but what confused me was the "timestamp" at the top of the page. For example, as I write this it reads "Updated 2 hours ago":

image

This is confusing, because if the tool fully processed all OTel repos (and hence the website too) 2 hours ago, then the legal status should have been updated.

chalin commented 11 months ago

Btw, would it be possible to add a title to the "Updated" text so that it shows the actual timestamp (similarly to what GitHub does)?

tegioz commented 11 months ago

That makes sense, but what confused me was the "timestamp" at the top of the page. For example, as I write this it reads "Updated 2 hours ago":

Yes, I understand. That timestamp is updated every time the project score is updated, which happens when any of the repositories is updated. Maybe we can add an information icon that explains this a bit in a popover.

tegioz commented 11 months ago

Btw, would it be possible to add a title to the "Updated" text so that it shows the actual timestamp (similarly to what GitHub does)?

We could do that, yes.

tegioz commented 11 months ago

We could also display this information per repository as well.

chalin commented 11 months ago

Since a project's scores can depend on its website, wouldn't it make sense to check whether the website has changed? A good candidate file to check would be the sitemap. WDYT?

tegioz commented 11 months ago

We'd rather not to do that. The reason is that there are more pieces of information that are not directly available on the repository's content and that we'd need to check if they've changed: releases, annual reviews, some security checks, etc. Tracking all those sources for changes, in addition to increase our chances to have problems with rate limits in some cases, would also increase the complexity of CLOMonitor. And IMHO it is not worth it given that in the worst case, everything will be updated within a day.

tegioz commented 10 months ago

If this is correct it should be fixed automatically in less than 5 hours (unless something is committed to the community repository before) 😇

The check passed on the next run, all good now 🙂

chalin commented 10 months ago

Ok, what ever solution you think is most appropriate. As long as we can resolve the ambiguity / placebo effect of the current page-wide timestamp.

Maybe we can add an information icon that explains this a bit in a popover.

Yes, that sounds helpful.