[PR #4920] ci: add OpenSSF Scorecard analysis workflow #6677

Open
opened 2026-11-01 21:42:14 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4920
Author: @Abhiiishek44
Created: 10/17/2026
Status: 🔄 Open

Base: main ← Head: ci/add-openssf-scorecard


📝 Commits (2)

  • ac26058 ci: add OpenSSF Scorecard analysis workflow
  • dada15a ci: trigger Scorecard on branch protection changes

📊 Changes

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

View changed files

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

📄 Description

Summary

Adds a GitHub Actions workflow to run OpenSSF Scorecard and publish security assessment results for morluto/rea.

The repository currently has no published Scorecard results, so external supply-chain tools cannot retrieve its security assessment. This workflow runs on pushes to main and weekly, publishes results to the public Scorecard API, and uploads SARIF findings to GitHub Code Scanning.

The change is limited to a new CI workflow and does not affect existing build or release processes.

Fixes #4898

Problem and expected behavior

REA does not currently publish OpenSSF Scorecard results, so third-party services cannot retrieve its security assessment through the public Scorecard API.

The new workflow runs Scorecard on pushes to main and weekly, publishing results for external consumers and uploading SARIF findings to GitHub Code Scanning.

Change and scope

Added .github/workflows/scorecard.yml using the official ossf/scorecard-action.

  • Runs on pushes to main and every Saturday.
  • Publishes results with publish_results: true.
  • Uploads SARIF output as a workflow artifact and to GitHub Code Scanning.
  • Uses SHA-pinned actions and disables persisted checkout credentials.
  • Limits workflow permissions to read-only by default, with id-token: write and security-events: write for the analysis job.

The change is limited to CI. Existing build, test, and release workflows remain unchanged.

Contract and boundary impact

  • Semantic owner and earliest changed stage: GitHub Actions; new Scorecard analysis workflow.
  • Contribution scope fit and linked maintainer decision: CI-only security reporting. No new provider or target-execution capability. Maintainer scope decision for target interaction: not applicable.
  • CLI and MCP/tool-catalog contract: No changes.
  • Provider, bridge, target-format, or platform compatibility: No changes.
  • Evidence, artifact, provenance, or reconstruction contract: No changes to REA's analysis Evidence. The workflow generates a separate SARIF report.
  • Target selection, authority, upstream behavior, and cleanup details: Not applicable to target analysis. The workflow reads repository metadata and publishes Scorecard results externally.
  • 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.

The checked effects refer to GitHub Actions execution, repository inspection, and public result publishing, not execution against reverse-engineering targets.

Evidence and regression coverage

  • Tests added or updated: No test files changed. Existing workflow action-pinning checks passed (5/5).
  • Base reproduction or other evidence: The public Scorecard API returned HTTP 404 before this change. No Scorecard workflow was present in the upstream repository.
  • User-visible CLI/MCP output: Not applicable.
  • Remaining proof gaps: Public Scorecard publication and SARIF upload cannot be verified until the workflow runs on upstream main.

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • npm run check — passed.
  • actionlint v1.7.7 with repository CI flags — passed.
  • Workflow action-pinning tests — 5/5 passed.
  • oxfmt --check — passed.
  • git diff --check — passed.
  • Git pre-push typecheck and lint — passed.

Compatibility, safety, and release

  • Breaking changes or migration steps: None.
  • Real Hopper/Ghidra, browser, or OS coverage: Not applicable; no provider or target behavior changes.
  • Package or release metadata impact: None.
  • Security, privacy, process, or containment review: Uses SHA-pinned actions, read-only default permissions, and only the additional permissions required for Scorecard publishing and SARIF upload. Checkout credentials are not persisted. Results are intentionally published publicly.

Author readiness

Human owner: @Abhiiishek44

  • 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/4920 **Author:** [@Abhiiishek44](https://github.com/Abhiiishek44) **Created:** 10/17/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `ci/add-openssf-scorecard` --- ### 📝 Commits (2) - [`ac26058`](https://github.com/morluto/rea/commit/ac26058d09d5945d1bbe90d6264113a58975a230) ci: add OpenSSF Scorecard analysis workflow - [`dada15a`](https://github.com/morluto/rea/commit/dada15a4329935b938d096d8cc47ad6a5ff92cb7) ci: trigger Scorecard on branch protection changes ### 📊 Changes **1 file changed** (+40 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/scorecard.yml` (+40 -0) </details> ### 📄 Description ## Summary Adds a GitHub Actions workflow to run OpenSSF Scorecard and publish security assessment results for morluto/rea. The repository currently has no published Scorecard results, so external supply-chain tools cannot retrieve its security assessment. This workflow runs on pushes to main and weekly, publishes results to the public Scorecard API, and uploads SARIF findings to GitHub Code Scanning. The change is limited to a new CI workflow and does not affect existing build or release processes. Fixes #4898 ## Problem and expected behavior REA does not currently publish OpenSSF Scorecard results, so third-party services cannot retrieve its security assessment through the public Scorecard API. The new workflow runs Scorecard on pushes to `main` and weekly, publishing results for external consumers and uploading SARIF findings to GitHub Code Scanning. ## Change and scope Added `.github/workflows/scorecard.yml` using the official `ossf/scorecard-action`. - Runs on pushes to `main` and every Saturday. - Publishes results with `publish_results: true`. - Uploads SARIF output as a workflow artifact and to GitHub Code Scanning. - Uses SHA-pinned actions and disables persisted checkout credentials. - Limits workflow permissions to read-only by default, with `id-token: write` and `security-events: write` for the analysis job. The change is limited to CI. Existing build, test, and release workflows remain unchanged. ## Contract and boundary impact - **Semantic owner and earliest changed stage:** GitHub Actions; new Scorecard analysis workflow. - **Contribution scope fit and linked maintainer decision:** CI-only security reporting. No new provider or target-execution capability. Maintainer scope decision for target interaction: not applicable. - **CLI and MCP/tool-catalog contract:** No changes. - **Provider, bridge, target-format, or platform compatibility:** No changes. - **Evidence, artifact, provenance, or reconstruction contract:** No changes to REA's analysis Evidence. The workflow generates a separate SARIF report. - **Target selection, authority, upstream behavior, and cleanup details:** Not applicable to target analysis. The workflow reads repository metadata and publishes Scorecard results externally. - **Generated metadata, package, or installation impact:** None. Expected effects: - [x] Read existing files or captured data. - [ ] Launch or attach to a process. - [x] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [x] 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. The checked effects refer to GitHub Actions execution, repository inspection, and public result publishing, not execution against reverse-engineering targets. ## Evidence and regression coverage - **Tests added or updated:** No test files changed. Existing workflow action-pinning checks passed (5/5). - **Base reproduction or other evidence:** The public Scorecard API returned HTTP 404 before this change. No Scorecard workflow was present in the upstream repository. - **User-visible CLI/MCP output:** Not applicable. - **Remaining proof gaps:** Public Scorecard publication and SARIF upload cannot be verified until the workflow runs on upstream `main`. For evidence-bearing changes: - [x] Observed, derived, and inferred claims remain distinguishable. - [x] Artifact identity, source provenance, and failed attempts remain preserved. - [x] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm run check` — passed. - `actionlint` v1.7.7 with repository CI flags — passed. - Workflow action-pinning tests — 5/5 passed. - `oxfmt --check` — passed. - `git diff --check` — passed. - Git pre-push typecheck and lint — passed. ## Compatibility, safety, and release - **Breaking changes or migration steps:** None. - **Real Hopper/Ghidra, browser, or OS coverage:** Not applicable; no provider or target behavior changes. - **Package or release metadata impact:** None. - **Security, privacy, process, or containment review:** Uses SHA-pinned actions, read-only default permissions, and only the additional permissions required for Scorecard publishing and SARIF upload. Checkout credentials are not persisted. Results are intentionally published publicly. ## Author readiness Human owner: @Abhiiishek44 - [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 - [x] 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. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [x] 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>
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#6677
No description provided.