44
55name : Scorecard supply-chain security
66on :
7+ # For Branch-Protection check. Only the default branch is supported. See
8+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
79 branch_protection_rule :
10+ # To guarantee Maintained check is occasionally updated. See
11+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
812 schedule :
913 - cron : ' 41 10 * * 2'
1014 push :
1115 branches : ['main']
1216
17+ # Declare default permissions as read only.
1318permissions : read-all
1419
1520jobs :
1621 analysis :
1722 name : Scorecard analysis
1823 runs-on : ubuntu-latest
1924 permissions :
25+ # Needed to upload the results to code-scanning dashboard.
2026 security-events : write
27+ # Needed to publish results and get a badge (see publish_results below).
2128 id-token : write
29+ # Uncomment the permissions below if installing in a private repository.
30+ # contents: read
31+ # actions: read
2232
2333 steps :
2434 - name : ' Checkout code'
25- uses : actions/checkout@v4
35+ uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
2636 with :
2737 persist-credentials : false
2838
@@ -31,17 +41,32 @@ jobs:
3141 with :
3242 results_file : results.sarif
3343 results_format : sarif
44+ # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
45+ # - you want to enable the Branch-Protection check on a *public* repository, or
46+ # - you are installing Scorecard on a *private* repository
47+ # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
48+ # repo_token: ${{ secrets.SCORECARD_TOKEN }}
49+
50+ # Public repositories:
51+ # - Publish results to OpenSSF REST API for easy access by consumers
52+ # - Allows the repository to include the Scorecard badge.
53+ # - See https://github.com/ossf/scorecard-action#publishing-results.
54+ # For private repositories:
55+ # - `publish_results` will always be set to `false`, regardless
56+ # of the value entered here.
3457 publish_results : true
3558
36- # Upload the results as artifacts
59+ # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
60+ # format to the repository Actions tab.
3761 - name : ' Upload artifact'
38- uses : actions/upload-artifact@v4
62+ uses : actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.pre.node20
3963 with :
4064 name : SARIF file
4165 path : results.sarif
4266 retention-days : 5
4367
44- # Upload the results to GitHub's code scanning dashboard
68+ # Upload the results to GitHub's code scanning dashboard (optional).
69+ # Commenting out will disable upload of results to your repo's Code Scanning dashboard
4570 - name : ' Upload to code-scanning'
4671 uses : github/codeql-action/upload-sarif@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3
4772 with :
0 commit comments