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

README: show of OpenSSF Scorecard badge #187

Merged
merged 1 commit into from Jun 15, 2023

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Jun 15, 2023

With the recent enabling of Scorecard updates, the badge accurately reflects the current status. Let's show it...

README.md Outdated
@@ -1,6 +1,7 @@
# A minimal logging API for Go

[![Go Reference](https://pkg.go.dev/badge/github.com/go-logr/logr.svg)](https://pkg.go.dev/github.com/go-logr/logr)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/go-logr/logr/badge)](https://api.securityscorecards.dev/projects/github.com/go-logr/logr)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is exactly the snipped from https://github.com/ossf/scorecard#scorecard-badges. However, it links to a URL which just returns some JSON. Wouldn't it be better to use a link which shows some human-friendly rendering?

@pnacht: you used https://deps.dev/go/github.com%2Fgo-logr%2Flogr for that. Is that a link that we can use here?

Copy link
Contributor

@pnacht pnacht Jun 15, 2023

Choose a reason for hiding this comment

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

Yep! However, I'd actually suggest you use the new version meant to replace that json dump. It hasn't been officially released yet (just waiting to add a few more input modes, see ossf/scorecard-webapp#415), but already works:

https://securityscorecards.dev/viewer/?platform=github.com&org=go-logr&repo=logr

This page is focused solely on Scorecard results. deps.dev has more information regarding dependencies and dependents, but only shows a subset of Scorecard scores (there are 18 checks in total, all of which can be seen in the link above, but deps.dev only shows 9).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've switched to that.

With the recent enabling of Scorecard updates, the badge accurately reflects
the current status. Let's show it...
@thockin thockin merged commit 73d5d25 into go-logr:master Jun 15, 2023
14 checks passed
@thockin
Copy link
Contributor

thockin commented Jun 15, 2023

error processing signature: executing scorecard-api call: Post "https://api.securityscorecards.dev/projects/github.com/go-logr/logr": context deadline exceeded

@pnacht
Copy link
Contributor

pnacht commented Jun 15, 2023

Woah, looking into this now!

@thockin
Copy link
Contributor

thockin commented Jun 15, 2023 via email

@pnacht
Copy link
Contributor

pnacht commented Jun 15, 2023

Can you try simply re-running the failed run? Just follow that link and, on the "..." menu on the right side of the page, click "Re-run failed jobs".

I just tried running it on my own fork and some other active projects that have installed the Action and it worked fine... regardless, I'll report this to the Scorecard team.

@thockin
Copy link
Contributor

thockin commented Jun 15, 2023

Re-running it was OK.

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.

None yet

3 participants