Skip to content

chore(security): add OpenSSF Scorecard workflow - #293

Merged
cschetan77 merged 2 commits into
mainfrom
security/add-scorecard
Nov 5, 2026
Merged

cschetan77 merged 2 commits into
mainfrom
security/add-scorecard

Conversation

@nirmal-joishi-a0

@nirmal-joishi-a0 nirmal-joishi-a0 commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

✏️ Changes

This pull request adds a security hardening workflow. No functional changes are introduced.

OpenSSF Scorecard

This PR adds .github/workflows/scorecard.yml. It calls ossf/scorecard-action directly (SHA-pinned to v2.4.3) — no composite action wrapper, no cross-org dependency. Results are uploaded to the Code Scanning dashboard via github/codeql-action/upload-sarif.

Placeholders to fill in before merging

Placeholder Description
publish_results: false Default. Set to true to publish results to the public Scorecard API and enable the badge — also requires uncommenting id-token: write in the job permissions. Leave as false to keep results private (the id-token: write line can remain commented out).

🟠 Declining this workflow

This is an organization-enforced security-hardening workflow, so closing this PR is not enough — the tool treats a plain close as a discard and opens a fresh replacement PR on its next run.

To permanently decline this category, a maintainer must close this PR and add one of these labels to it:

Label Use when
remediation: not-required The category is already handled another way for this repo.
remediation: not-applicable The category genuinely does not apply (e.g. there is no manifest to scan for SCA, or no release/build CI to wire the malware scan into).

Applying a label requires write, triage, or admin access, so the label is a trusted maintainer signal. Once a closed PR carries one of these labels, the tool respects the decline and will not reopen a replacement.

🔮 Type of Change

  • Standard

🔗 References

This change applies a standard automated security-scanning workflow as part of routine repository hardening.

  • I explained why this change is needed.

📖 Documentation

No user-facing changes have been introduced.

  • I reflected this change in the (internal and/or user-facing) documentation, or added an explanation for why no documentation update is needed.

🎯 Testing

⚠️ This workflow runs on this PR. Before merging, confirm that run triggers and passes, and that a green result is not masking a skipped or silently-ignored scan.

  • The PR run has been verified green in this repository's CI (not a skipped/empty result).

🚀 Deployment

  • This change can support multiple releases of the code serving traffic at the same time.

🔥 Rollback

Reverting this PR removes the added workflow file — no further action required.

  • I explained what the rollback for this change will look like.

@nirmal-joishi-a0
nirmal-joishi-a0 requested a review from a team as a code owner October 8, 2026 10:48
@nirmal-joishi-a0

Copy link
Copy Markdown
Contributor Author

@auth0/project-dx-sdks-engineer-codeowner please review the files in the PR. This automated security-hardening workflow is untested in this repo — before merging, confirm it triggers and passes (and is not silently ignoring failures); do not merge on a green result alone.

@nirmal-joishi-a0

Copy link
Copy Markdown
Contributor Author

An internal service ticket has been filed for the owning team to review and merge this PR.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@cschetan77
cschetan77 force-pushed the security/add-scorecard branch from 198f9d3 to 4cc3c01 Compare November 4, 2026 12:37
nirmal-joishi-a0 and others added 2 commits November 4, 2026 18:09
Drop the experimental pull_request trigger, the redundant SARIF artifact
upload and the fork guard that only applied to pull_request. Trim comments.
@cschetan77
cschetan77 force-pushed the security/add-scorecard branch from 4cc3c01 to 9f1a4de Compare November 4, 2026 12:39
@cschetan77
cschetan77 merged commit f0ad566 into main Nov 5, 2026
13 checks passed
@cschetan77
cschetan77 deleted the security/add-scorecard branch November 5, 2026 05:24
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.

4 participants