Repository navigation
🏗️✨:grade the defaults security practices - #921
Conversation
The SDK has been graded by OpenSSF Scorecard since it started running its own workflow, and this repository has not, although the practices the grade measures are largely decided here: the branch protection, the pinned actions, the token permissions every repository inherits. Whoever arrives from a published package and follows the metadata back here finds the community health files without the grade that the code carries. The same workflow answers that, and it needs nothing this repository does not already have: no secret, no app, and the analysis waits on a public repository rather than failing until there is one. The result is pinned to the same commit of `github/codeql-action` that `codeql-analysis.yml` already uses, so the two move together when renovate moves them. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5 Refs: #178
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (2)
Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour. 📝 WalkthroughWalkthroughThe pull request adds a GitHub Actions workflow that runs OpenSSF Scorecard on selected repository events and a weekly schedule. It restricts permissions, pins actions to commit SHAs, and uploads SARIF results. It also updates project terms. ChangesScorecard analysis
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Feature Sequence Diagram(s)sequenceDiagram
participant GitHubActions
participant Repository
participant OpenSSFScorecard
participant SecurityTab
GitHubActions->>Repository: Check out repository without persisted credentials
Repository->>OpenSSFScorecard: Provide repository contents
OpenSSFScorecard->>GitHubActions: Generate and publish SARIF results
GitHubActions->>SecurityTab: Upload SARIF report
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Requested by DerekNonGeneric
Before: the SDK's Security tab carries an OpenSSF Scorecard grade and this
repository's does not, although most of what that grade measures — the branch
protection, the pinned actions, the token permissions — is decided here and
inherited from here. Whoever arrives from a published package and follows the
metadata back finds the community health files without the grade the code
carries.
After: this repository is graded by the same workflow on the same schedule, and
the result appears in its own Security tab.
It adds
.github/workflows/scorecard.yml, ported from the SDK, along with thethree words the spell checker needs to read it.
How: the workflow runs on a push to
main, on a branch protection rule change,and weekly on Monday in a slot clear of the CodeQL, Semgrep and link-rot runs.
It needs no secret and no app. The analysis is skipped while the repository is
private, because the checks read history through an API the default token cannot
reach on a private one and publishing a result is public by definition. The
SARIF upload is pinned to the same
github/codeql-actioncommit thatcodeql-analysis.ymlalready uses, so renovate moves the two together.This is the workflow only. The checks that need a decision rather than a file —
branch protection above all — are still open on the issue.
Refs: #178