Scorecard supply-chain security #83
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
# .github/workflows/scorecard.yml | |
# Reference: https://github.com/ossf/scorecard/blob/main/.github/workflows/scorecard-analysis.yml | |
--- | |
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: | |
push: | |
# Only the default branch is supported. | |
branches: ["main", "master"] | |
# To guarantee Maintained check is occasionally updated. See | |
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained | |
schedule: | |
# Weekly on Fridays. | |
- cron: '18 9 * * 5' | |
# Declare default permissions as read only. | |
permissions: {} | |
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 | |
# Uncomment the permissions below if installing in a private repository. | |
contents: read | |
actions: read | |
steps: | |
- name: "Checkout code" | |
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
with: | |
submodules: true | |
persist-credentials: false | |
- name: "Run analysis" | |
uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2 | |
with: | |
results_file: results.sarif | |
results_format: sarif | |
# Read-only PAT token. To create it, | |
# follow the steps in https://github.com/ossf/scorecard-action#pat-token-creation. | |
repo_token: ${{ secrets.SCORECARD_TOKEN }} | |
# Publish the results to enable scorecard badges. For more details, see | |
# https://github.com/ossf/scorecard-action#publishing-results. | |
# If you are installing the action on a private repo, set it to `publish_results: false` | |
# or comment out the following line. | |
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@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 | |
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@d6bbdef45e766d081b84a2def353b0055f728d3e # v3.29.3 | |
with: | |
sarif_file: results.sarif |