Skip to content

Add Scorecard and REUSE checks with README badges - #205

Open
MehdiMamas wants to merge 2 commits into
mainfrom
launch-badges-203
Open

MehdiMamas wants to merge 2 commits into
mainfrom
launch-badges-203

Conversation

@MehdiMamas

@MehdiMamas MehdiMamas commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

Part of #199, closes #203 (no-account items).

  • Scorecard workflow (publishes the badge), REUSE lint workflow, LICENSES/MIT.txt, REUSE.toml, two README badges.
  • Checked: reuse lint compliant (219/219 files), workflow YAML parses.
  • Not done here, need the owner: OpenSSF Best Practices sign-up, GitHub Sponsors. Contributor Covenant badge waits for CODE_OF_CONDUCT.md.

Plan: #203 (comment)

Before: no supply-chain scorecard, no machine-checked licensing, no badges.
Now: Scorecard publishes weekly and on main, REUSE lint runs on every PR, README shows both badges.
Before: badges sat below the demo GIF.
Now: they join the badge row at the top.
@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given a pull request from a fork -> the Scorecard workflow does not run on it (push, schedule and manual only), so no publish happens from untrusted code — .github/workflows/scorecard.yml:2
  • pass: given Scorecard publish is rejected or the network fails -> the step warns and the CI run does not fail the repository checks — .github/workflows/scorecard.yml:23
  • pass: given a file with no SPDX header (source, lockfile, image, binary) -> REUSE.toml glob ** covers it and reuse lint passes — REUSE.toml:3
  • pass: given a new file added later -> covered by the same glob, no per-file edit needed — REUSE.toml:4
  • pass: given reuse lint fails -> the REUSE workflow fails — .github/workflows/reuse.yml:17
  • pass: given CODE_OF_CONDUCT.md does not exist yet -> no Contributor Covenant badge is added here — README.md:12
  • pass: given the Scorecard badge before the first published run -> README shows it unresolved until the first run on main, which is expected — README.md:18

Tests: reuse lint compliant 229/229; CI 4 checks green (ubuntu, macos, windows, reuse).

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review:

  • Plan mismatch: the only Plan comment on Launch 4/5: values badges and communities (OpenSSF, Scorecard, REUSE, Sponsors, pledge) #203 describes a batch-gate pickCheckout change (batch-gate.mjs, batch-gate-checkout.test.mjs). It has nothing to do with this PR's Scorecard/REUSE/badge work, and the PR body names no Plan. I couldn't check the diff against a Plan for these items. Post or point to the right Plan.
  • .github/workflows/scorecard.yml:35 and :34: github/codeql-action/upload-sarif is pinned to v3.28.0 (SHA verified). v3 of the codeql-action is being retired, so move to a v4 SHA at some point. This doesn't block the merge.
  • LICENSES/MIT.txt:3 keeps the <year> <copyright holders> placeholder. That is the standard REUSE template and is legal, because the real copyright is in REUSE.toml and LICENSE. Say so if it was intentional.
  • REUSE.toml:3-4 uses path = "**" with aggregate precedence, so every file, including vendored or generated ones, is attributed to the owner. That is fine if the repo has no third-party files.

Checked and fine: all five action SHAs resolve to their commented tags. Permissions are read-only at the top level, and the scorecard job's extra scopes (security-events and id-token write) are what publish_results needs. The checkout steps set persist-credentials: false. reuse.yml has contents: read only.

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check: PR 205 against the amended Plan; the withdrawn Plan's cases are dropped

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check: PR 205 against the amended Plan; the withdrawn Plan's cases are dropped

This branch has not been deployed

No deployments
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.

Launch 4/5: values badges and communities (OpenSSF, Scorecard, REUSE, Sponsors, pledge)

1 participant