Scorecard analysis workflow #23
This file contains 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 runs the OSSF Scorecard analysis and is based on the workflow at: | |
| # https://github.com/ossf/scorecard/blob/main/.github/workflows/scorecard-analysis.yml | |
| name: Scorecard analysis workflow | |
| 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 | |
| push: | |
| # Only the default branch is supported. | |
| branches: | |
| - main | |
| schedule: | |
| - cron: '25 14 * * 3' | |
| # 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 for GitHub OIDC token to publish results and get a badge (see | |
| # publish_results below). | |
| id-token: write | |
| # Uncomment the permissions below if installing in a private repository. | |
| # contents: read | |
| # actions: read | |
| steps: | |
| - name: "Checkout code" | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| persist-credentials: false | |
| - name: "Run analysis" | |
| uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0 | |
| 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 }} | |
| # Scorecard team runs a weekly scan of public GitHub repos, | |
| # see https://github.com/ossf/scorecard#public-data. | |
| # Setting `publish_results: true` helps us scale by leveraging your workflow to | |
| # extract the results instead of relying on our own infrastructure to run scans. | |
| # And it's free for you! | |
| # 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. | |
| # https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts | |
| - name: "Upload artifact" | |
| uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6 | |
| 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@eb055d739abdc2e8de2e5f4ba1a8b246daa779aa # v3.26.0 | |
| with: | |
| sarif_file: results.sarif |