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

docs: Add OpenSSF Scorecard status badge to README.md #11897

Merged
merged 1 commit into from
Sep 28, 2023
Merged

docs: Add OpenSSF Scorecard status badge to README.md #11897

merged 1 commit into from
Sep 28, 2023

Conversation

redenferno
Copy link
Contributor

@redenferno redenferno commented Sep 27, 2023

Created OpenSSF Scorecard badge for project README.

Motivation

This was requested by @agilgur5 as part of #9769

Verification

image

Created OpenSSF Scorecard badge for project README.

Signed-off-by: redenferno <100324701+redenferno@users.noreply.github.com>
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in for less badges unless really needed

@agilgur5
Copy link

agilgur5 commented Sep 28, 2023

@terrytangyuan generally I am agreed on that.

In this case, this is specifically for the CNCF CLOMonitor, for which #9769 is a tracking issue. That issue was from last year's CNCF Security Slam, which will start up again this year in around ~2 weeks (I'm planning on working on SLSA Level 3 and 4, as discussed in SIG Security yesterday).

We are missing two badges for CLOMonitor, this is one of them. Although the OpenSSF Scorecard also requires running in CI, which we don't currently do as far as I know, so I think this badge is using an old result(?) or something.

As CLOMonitor is a metric CNCF highlights for supply chain security, I think it would be good to bring our score up and in line with CD.

@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Sep 28, 2023
Copy link

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@redenferno have you worked on setting up the scorecard action? Without that the badge is a bit premature

If you haven't, I was planning to pick it up simultaneously with SLSA in October

@terrytangyuan terrytangyuan merged commit ad28425 into argoproj:master Sep 28, 2023
@terrytangyuan
Copy link
Member

Thanks

@eddie-knight
Copy link
Contributor

@redenferno have you worked on setting up the scorecard action? Without that the badge is a bit premature

If you haven't, I was planning to pick it up simultaneously with SLSA in October

FYI @agilgur5, the Scorecard score presented in the badge will be accurate to the last weekly cron job (Google sponsors a scan of over a million repos every week, including this one).

The GitHub Action can serve to increase the precision by updating the score whenever new code is merged, but it isn't a prerequisite for the badge.

@agilgur5
Copy link

agilgur5 commented Oct 4, 2023

FYI @agilgur5, the Scorecard score presented in the badge will be accurate to the last weekly cron job (Google sponsors a scan of over a million repos every week, including this one).

Oh I didn't know that, thanks for the context!
Could you link to a source for this? like docs from OpenSSF or the repo for this cron job?

@eddie-knight
Copy link
Contributor

I didn't find anything in the docs yet, but I know this because the maintainers made sure it was included in the LF Course on the topic. They probably should add it to the docs more clearly.

Here is confirmation from the BigQuery data that argo workflows is included in the cron:

Screen Shot 2023-10-04 at 1 27 57 PM

@agilgur5
Copy link

agilgur5 commented Oct 17, 2023

Ah I found it. There are docs on this in the "Public Data" section of the scorecard README. It links to a CSV in the repo of all projects tracked as well (though it's ~70mb so it can be difficult to load 😅 ). I believe the cron directory that the CSV is in has the code for the cron job as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants