Skip to content

README: add some badges#48655

Merged
thaJeztah merged 1 commit intomoby:masterfrom
thaJeztah:vanity_badges
Oct 16, 2024
Merged

README: add some badges#48655
thaJeztah merged 1 commit intomoby:masterfrom
thaJeztah:vanity_badges

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

Add badges for pkg.go.dev docs, go-reportcard, and OpenSSF score.

Add badges for pkg.go.dev docs, go-reportcard, and OpenSSF score.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
Copy link
Copy Markdown
Contributor

@austinvazquez austinvazquez left a comment

Choose a reason for hiding this comment

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

LGTM

@tianon
Copy link
Copy Markdown
Member

tianon commented Oct 15, 2024

Big +1 to the Go reference link, but IMO the other two are kind of tacky (🙈)

I'm not opposed strongly enough to try and block, though 🙇

Copy link
Copy Markdown
Contributor

@vvoland vvoland left a comment

Choose a reason for hiding this comment

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

LGTM

@thaJeztah
Copy link
Copy Markdown
Member Author

but IMO the other two are kind of tacky (🙈)

Yeah, I must admit that;

  • The GoReportCard one has become less relevant over the years; I still use it periodically, because for some reason it picks gofmt issues that are not picked up by our GolangCI-lint config (we should probably try and fix that)
  • Somewhat mixed feelings on the OpenSSF ScoreCard;
    • ✅ it helped pick up some genuine missing configurations in our GitHub actions (some running too permissive), and
    • ✅ I agree on the score it gave to our SECURITY.md (touch-up security policy #48280)
    • 🤷‍♂️ Score on "is the repo actively maintained" is sometimes not relevant for stable repositories (no code churn needed on those)
    • 🤷‍♂️ Score on "has Fuzzing" is pretty poor; it only does a rudimentary check, so it's really just a "vanity score"
    • ❌ Score on having a badge for OpenSSF best practices (which requires granting permissions to some individual)
    • ⚠️ Not a fan of "pinning dependencies" score (but perhaps it could be with some additional rules); some dependencies (actions) are "trusted", and on purpose not pinned (to prevent release branches running outdated ones)

Things we should add, but are currently missing;

  • CI status: I left it out for now, because a couple of tests on master are failing on Windows 19.03. They could be either legit, or just limitations of the older Windows version; we should look into those and either fix, or skip them.
  • CodeCov: also somewhat debatable, because I know we have many more integration tests (and coverage that may not always be measured); still, there's definitely packages that could use some love to increase coverage; we should work on that (and CodeCov could assist in finding those).

@thaJeztah
Copy link
Copy Markdown
Member Author

Let me bring this one one, but we can update the list in future

@thaJeztah thaJeztah merged commit 277cd94 into moby:master Oct 16, 2024
@thaJeztah thaJeztah deleted the vanity_badges branch October 16, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants