[PR #5304] [CLOSED] ci: publish OpenSSF Scorecard results #6868

Closed
opened 2026-11-01 21:43:40 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5304
Author: @simlf
Created: 10/19/2026
Status: ❌ Closed

Base: main ← Head: fm/rea-scorecard


📝 Commits (1)

  • 0b936b8 ci: publish OpenSSF Scorecard results

📊 Changes

1 file changed (+45 additions, -0 deletions)

View changed files

➕ .github/workflows/scorecard.yml (+45 -0)

📄 Description

Summary

Refs #4898. Adds the official OpenSSF Scorecard workflow so REA publishes a Scorecard result that third-party tools (scorecard.dev, deps.dev, the Scorecard API) can read instead of reporting the repository as not measured.

Problem and expected behavior

REA already has strong supply-chain signals (SLSA provenance, npm trusted publishing, SHA-pinned actions), but no Scorecard result is published, so external viewers cannot see that posture. After merge, each push to main, a weekly schedule, and branch_protection_rule events run Scorecard, publish the result, and upload SARIF to code scanning.

Change and scope

Single new file, .github/workflows/scorecard.yml, following the ossf/scorecard-action template:

  • Triggers: push to main, weekly schedule, branch_protection_rule.
  • Top-level permissions: read-all; the job adds only security-events: write (SARIF upload) and id-token: write (result publication).
  • publish_results: true; SARIF uploaded via github/codeql-action/upload-sarif and kept as a 5-day artifact.
  • Every action pinned to a full commit SHA with a version comment, matching existing workflows (scorecard-action v2.5.0 release tag, as suggested in the issue reply; checkout and upload-artifact reuse the SHAs already used in this repo; codeql-action v4.39.0). persist-credentials: false on checkout.

Not included: README badge. The issue reply suggests adding it once a result exists; that is a follow-up after the first run publishes. No other workflow or code change.

Contract and boundary impact

  • Semantic owner and earliest changed stage: CI configuration only.
  • Contribution scope fit and linked maintainer decision: not applicable (CI hygiene, no target interaction); discussed in #4898.
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: none.
  • Evidence, artifact, provenance, or reconstruction contract: none.
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable.
  • Generated metadata, package, or installation impact: none.

Expected effects:

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none; the workflow has no repository test surface.
  • Base reproduction or other evidence: action SHAs resolved from upstream release tags via the GitHub API (ossf/scorecard-action v2.5.0 → fa7117d…, github/codeql-action v4.39.0 → 6f2ac81…).
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: the workflow has not run yet; it only triggers on main, so the first real run happens after merge. Scorecard publication may require the repository's code scanning to be available.

Validation performed

  • npx prettier --check .github/workflows/scorecard.yml — passes.
  • actionlint not available locally — not run.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: job token write scope is limited to security-events and id-token; results are published publicly by design of publish_results.

Author readiness

Human owner: @simlf

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/5304 **Author:** [@simlf](https://github.com/simlf) **Created:** 10/19/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fm/rea-scorecard` --- ### 📝 Commits (1) - [`0b936b8`](https://github.com/morluto/rea/commit/0b936b8c53a649838ddd327604cd778f31e92ea8) ci: publish OpenSSF Scorecard results ### 📊 Changes **1 file changed** (+45 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/scorecard.yml` (+45 -0) </details> ### 📄 Description ## Summary Refs #4898. Adds the official OpenSSF Scorecard workflow so REA publishes a Scorecard result that third-party tools (scorecard.dev, deps.dev, the Scorecard API) can read instead of reporting the repository as not measured. ## Problem and expected behavior REA already has strong supply-chain signals (SLSA provenance, npm trusted publishing, SHA-pinned actions), but no Scorecard result is published, so external viewers cannot see that posture. After merge, each push to `main`, a weekly schedule, and `branch_protection_rule` events run Scorecard, publish the result, and upload SARIF to code scanning. ## Change and scope Single new file, `.github/workflows/scorecard.yml`, following the ossf/scorecard-action template: - Triggers: `push` to `main`, weekly `schedule`, `branch_protection_rule`. - Top-level `permissions: read-all`; the job adds only `security-events: write` (SARIF upload) and `id-token: write` (result publication). - `publish_results: true`; SARIF uploaded via `github/codeql-action/upload-sarif` and kept as a 5-day artifact. - Every action pinned to a full commit SHA with a version comment, matching existing workflows (scorecard-action v2.5.0 release tag, as suggested in the issue reply; checkout and upload-artifact reuse the SHAs already used in this repo; codeql-action v4.39.0). `persist-credentials: false` on checkout. Not included: README badge. The issue reply suggests adding it once a result exists; that is a follow-up after the first run publishes. No other workflow or code change. ## Contract and boundary impact - Semantic owner and earliest changed stage: CI configuration only. - Contribution scope fit and linked maintainer decision: not applicable (CI hygiene, no target interaction); discussed in #4898. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable. - Generated metadata, package, or installation impact: none. Expected effects: - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none; the workflow has no repository test surface. - Base reproduction or other evidence: action SHAs resolved from upstream release tags via the GitHub API (`ossf/scorecard-action` v2.5.0 → `fa7117d…`, `github/codeql-action` v4.39.0 → `6f2ac81…`). - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: the workflow has not run yet; it only triggers on `main`, so the first real run happens after merge. Scorecard publication may require the repository's code scanning to be available. ## Validation performed - `npx prettier --check .github/workflows/scorecard.yml` — passes. - actionlint not available locally — not run. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. - Package or release metadata impact: none. - Security, privacy, process, or containment review: job token write scope is limited to `security-events` and `id-token`; results are published publicly by design of `publish_results`. ## Author readiness Human owner: @simlf - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [ ] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [ ] The PR has one focused outcome and the title follows `type(scope): outcome`. - [ ] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [ ] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [ ] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:43:40 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#6868
No description provided.