feat(ste-576): add gh action for OSSF Scorecard - #129
Conversation
|
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:
For more information about GitHub Code Scanning, check out the documentation. |
brikin01
left a comment
There was a problem hiding this comment.
Thanks for adding this scorecard, I think it will be useful!
I added a few comments around bumping versions to their latest.
Also, do we need all of these template comments? A lot of them repeat the upstream docs or describe options we aren’t using, and they make the workflow a bit harder to scan. Could we keep just the comments that explain repo-specific or security-related choices?
I will remove any redundant comments. However, would like to keep the other options not used here along with their comments, as it would help later if we decide to change something. We know these options exist & could go search for them in their documentation directly. I understand its not neat, but atleast we know an option exists because of these commented lines of code. |
There was a problem hiding this comment.
Pull request overview
Adds OpenSSF Scorecard visibility for this repository by introducing a scheduled/triggered Scorecard GitHub Action workflow and surfacing the Scorecard badge in the README.
Changes:
- Add OpenSSF Scorecard badge to
README.md. - Add
.github/workflows/scorecard.ymlto run Scorecard, upload SARIF artifacts, and publish results for the badge.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds an OpenSSF Scorecard badge link at the top of the README. |
| .github/workflows/scorecard.yml | Introduces the Scorecard workflow to generate/upload SARIF and publish Scorecard results. |
Suppressed comments (1)
.github/workflows/scorecard.yml:54
publish_resultsis set to true even onpull_requestruns, but the comment above notes publishing only works from the default branch. Disabling publishing on PR events avoids confusion and unnecessary API calls.
# Public repositories:
# - Publish results to OpenSSF REST API for easy access by consumers
# - Allows the repository to include the Scorecard badge.
# - See https://github.com/ossf/scorecard-action#publishing-results.
# - only works when run from the default branch.
publish_results: true
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
GitHub Action for OpenSSF Scorecard - https://github.com/ossf/scorecard-action
Assess open source projects for security risks through a series of automated checklist - https://openssf.org/projects/scorecard/