scorecards.yml

# 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: # yamllint disable-line rule:truthy
    # For Branch-Protection check. Only the default branch is supported. See
    # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
    # eslint-disable-next-line yml/no-empty-mapping-value
    branch_protection_rule: # yamllint disable-line rule:empty-values
    # To guarantee Maintained check is occasionally updated. See
    # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
    schedule:
        - cron: "20 7 * * 2"
    push:
        branches: ["main"]

# Declare default permissions as read only.
permissions: "read-all"

jobs:
    analysis:
        name: "Scorecard analysis"
        runs-on: "ubuntu-latest"
        permissions:
            # Needed to upload the results to code-scanning dashboard.
            security-events: "write"
            # Needed to publish results and get a badge (see publish_results below).
            id-token: "write"
            contents: "read"
            actions: "read"

        steps:
            - name: "Harden Runner"
              uses: "step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895" # v2.6.1
              with:
                  egress-policy: "audit"

            - name: "Checkout code"
              uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
              with:
                  persist-credentials: false

            - name: "Run analysis"
              uses: "ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736" # v2.3.1
              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 Scorecards on a *private* repository
                  # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
                  # 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

            # 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@a8a3f3ad30e3422c9c7b888a15615d19a852ae32" # v3.1.3
              with:
                  name: "SARIF file"
                  path: "results.sarif"
                  retention-days: 5

            # Upload the results to GitHub's code scanning dashboard.
            - name: "Upload to code-scanning"
              uses: "github/codeql-action/upload-sarif@66b90a5db151a8042fa97405c6cf843bbe433f7b" # v2.22.7
              with:
                  sarif_file: "results.sarif"