Skip to content

feat(ste-576): add gh action for OSSF Scorecard - #129

Open
NeethuESim wants to merge 14 commits into
secure-buildfrom
stesol-576-ossf-scorecard
Open

feat(ste-576): add gh action for OSSF Scorecard#129
NeethuESim wants to merge 14 commits into
secure-buildfrom
stesol-576-ossf-scorecard

Conversation

@NeethuESim

Copy link
Copy Markdown
Collaborator

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/

@NeethuESim NeethuESim changed the title feat: add gh action for OSSF Scorecard feat(ste-576): add gh action for OSSF Scorecard Aug 5, 2026
@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.

Comment thread .github/workflows/scorecard.yml Fixed

@brikin01 brikin01 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Comment thread .github/workflows/scorecard.yml Outdated
Comment thread .github/workflows/scorecard.yml Outdated
Comment thread .github/workflows/scorecard.yml Outdated
Comment thread .github/workflows/scorecard.yml Outdated
@NeethuESim

Copy link
Copy Markdown
Collaborator Author

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.

@brikin01 brikin01 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml to 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_results is set to true even on pull_request runs, 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.

Comment thread .github/workflows/scorecard.yml
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