Skip to content

Add OpenSSF Scorecard and REUSE checks with README badges - #218

Open
MehdiMamas wants to merge 1 commit into
mainfrom
scorecard-reuse-pr
Open

MehdiMamas wants to merge 1 commit into
mainfrom
scorecard-reuse-pr

Conversation

@MehdiMamas

@MehdiMamas MehdiMamas commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

Closes #217

Plan: #217 (the Plan section of the issue body; edge cases are checked in the Check comment on this PR).

Replaces #205, which had the wrong Plan.

Changes: .github/workflows/scorecard.yml (push to main, weekly, manual; actions pinned to commit SHAs; read-all default permissions), .github/workflows/reuse.yml (license check on pull requests and main), LICENSES/MIT.txt, REUSE.toml (one rule, MIT), and two badges in the README badge row.

Tests: local license check reports compliant (236 of 236 files); CI on ubuntu, macos and windows.

Plan: #217 (comment)

Before: README had no Scorecard or REUSE badge; there were no scorecard or reuse workflows, no LICENSES/ folder and no REUSE.toml.
Now: scorecard.yml and reuse.yml run on pushes and pull requests with pinned actions and read-only permissions, LICENSES/MIT.txt and REUSE.toml cover the tree, and the README has the two badges; reuse lint reports compliant.
@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given reuse lint is run on the tree -> expect compliant, every file covered — REUSE.toml:4 (path = "**"); local license check: 236 of 236 files covered, compliant
  • pass: given the workflows' third-party actions -> expect each pinned to a commit SHA, default permissions read-only — .github/workflows/reuse.yml:7 (contents: read), .github/workflows/scorecard.yml:9 (read-all); actions pinned at scorecard.yml:20,23,28,33 and reuse.yml:14,17
  • open: given the badge URLs -> expect them to resolve once the first run on main completes — README.md:18,19; not checkable until the first run on main

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review: no problems found

Checked against the Plan in #217. All five files are present and match it.

  • Each third-party action SHA matches its tag comment. I resolved checkout v4.2.2, upload-artifact v4.6.2, codeql-action v3.28.0, scorecard-action v2.5.0 and reuse-action v6.0.0 through the GitHub API.
  • Default permissions are read-only: contents: read in reuse.yml and read-all in scorecard.yml.
  • scorecard.yml grants security-events and id-token write only on the analysis job, and both are needed for SARIF upload and publishing results.
  • Both checkouts use persist-credentials: false. No secrets are used.
  • The reuse check, the ubuntu, macos and windows CI jobs, and the README badge row are all in place. The badge URLs will resolve after the first run on main, as the Plan expects.

Not blocking: codeql-action v3.28.0 is an older v3 release, so a later bump to a newer one is worth doing.

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given reuse lint is run on the tree -> expect compliant, every file covered — REUSE.toml:4 (path = "**"); local license check: 236 of 236 files covered, compliant
  • pass: given the workflows' third-party actions -> expect each pinned to a commit SHA, default permissions read-only — .github/workflows/reuse.yml:7 (contents: read), .github/workflows/scorecard.yml:9 (read-all); actions pinned at scorecard.yml:20,23,28,33 and reuse.yml:14,17
  • dropped - given the badge URLs -> expect them to resolve once the first run on main completes - Add OpenSSF Scorecard and REUSE compliance (workflows, license files, badges) #217 (comment)

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given reuse lint is run on the tree -> expect compliant, every file covered — REUSE.toml:4 (path = "**"); local license check: 236 of 236 files covered, compliant
  • pass: given the workflows' third-party actions -> expect each pinned to a commit SHA, default permissions read-only — .github/workflows/reuse.yml:7 (contents: read), .github/workflows/scorecard.yml:9 (read-all); actions pinned at scorecard.yml:20,23,28,33 and reuse.yml:14,17
  • dropped - given the badge URLs -> expect them to resolve once the first run on main completes - Add OpenSSF Scorecard and REUSE compliance (workflows, license files, badges) #217 (comment)

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.

Add OpenSSF Scorecard and REUSE compliance (workflows, license files, badges)

1 participant