Scorecard supply-chain security #250
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow uses actions that are not certified by GitHub. They are provided | |
| # by a third-party and are governed by separate terms of service, privacy | |
| # policy, and support documentation. | |
| name: Scorecard supply-chain security | |
| on: | |
| # For Branch-Protection check. Only the default branch is supported. See | |
| # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection | |
| branch_protection_rule: | |
| # To guarantee Maintained check is occasionally updated. See | |
| # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained | |
| # Daily (was weekly): if any run catches a commit mid-CodeQL-scan, the next | |
| # run corrects it within a day instead of leaving a stale reading for a week. | |
| schedule: | |
| - cron: '24 17 * * *' | |
| # NOTE: the 'push: [main]' trigger was intentionally removed. It made this | |
| # workflow run at merge time, racing the CodeQL scan of the just-merged | |
| # commit. Scorecard would query for a SAST run before CodeQL had finished | |
| # producing one, reporting that commit as unchecked (e.g. 29/30). Running | |
| # only on schedule + branch_protection_rule means evaluation happens well | |
| # after CodeQL has completed, so merges no longer move the score. | |
| # Declare default permissions as read only. | |
| permissions: read-all | |
| jobs: | |
| analysis: | |
| name: Scorecard analysis | |
| runs-on: ubuntu-latest | |
| # `publish_results: true` only works when run from the default branch. | |
| # (The previous 'pull_request' clause here was dead code - this workflow | |
| # doesn't trigger on pull_request events.) | |
| if: github.event.repository.default_branch == github.ref_name | |
| # A job-level permissions block REPLACES the top-level 'read-all' default | |
| # entirely - anything not listed here is set to 'none'. The reads below are | |
| # required for Scorecard to enumerate commits/PRs and detect the CodeQL | |
| # check runs that the SAST check looks for. With them commented out, the | |
| # job effectively had no read access and relied entirely on SCORECARD_TOKEN. | |
| permissions: | |
| security-events: write # upload SARIF to the code-scanning dashboard | |
| id-token: write # publish results to the OpenSSF REST API | |
| contents: read # read commit history (the SAST evaluation window) | |
| actions: read # read workflow runs | |
| checks: read # read CodeQL check runs (the SAST signal) | |
| pull-requests: read # map merged commits to their PRs | |
| steps: | |
| - name: Harden the runner (Audit all outbound calls) | |
| uses: step-security/harden-runner@bf7454d06d71f1098171f2acdf0cd4708d7b5920 # v2.20.0 | |
| with: | |
| egress-policy: audit | |
| - name: "Checkout code" | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| persist-credentials: false | |
| - name: "Run analysis" | |
| uses: ossf/scorecard-action@2d1146689b8cda280b9bc96326124645441f03bc # v2.4.4 | |
| with: | |
| results_file: results.sarif | |
| results_format: sarif | |
| # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: | |
| # - you want to enable the Branch-Protection check on a *public* repository, or | |
| # - you are installing Scorecard on a *private* repository | |
| # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional. | |
| repo_token: ${{ secrets.SCORECARD_TOKEN }} | |
| # 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. | |
| # For private repositories: | |
| # - `publish_results` will always be set to `false`, regardless | |
| # of the value entered here. | |
| publish_results: true | |
| # (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore | |
| # file_mode: git | |
| # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF | |
| # format to the repository Actions tab. | |
| - name: "Upload artifact" | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: SARIF file | |
| path: results.sarif | |
| retention-days: 5 | |
| # Upload the results to GitHub's code scanning dashboard (optional). | |
| # Commenting out will disable upload of results to your repo's Code Scanning dashboard | |
| - name: "Upload to code-scanning" | |
| uses: github/codeql-action/upload-sarif@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4.37.3 | |
| with: | |
| sarif_file: results.sarif |