Skip to content

Commit 53ed190

Browse files
diogoteles08rbri
authored andcommitted
Add Scorecard Action (mozilla#1400)
Set up a scan for the Open Source Security Dashboard (see https://openssf.org/blog/2022/09/08/show-off-your-security-score-announcing-scorecards-badges/)
1 parent a024bea commit 53ed190

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

.github/workflows/scorecard.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# This workflow uses actions that are not certified by GitHub. They are provided
2+
# by a third-party and are governed by separate terms of service, privacy
3+
# policy, and support documentation.
4+
5+
name: Scorecard supply-chain security
6+
on:
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
9+
branch_protection_rule:
10+
# To guarantee Maintained check is occasionally updated. See
11+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
12+
schedule:
13+
- cron: '31 1 * * 3'
14+
push:
15+
branches: [ "master" ]
16+
17+
# Declare default permissions as read only.
18+
permissions: read-all
19+
20+
jobs:
21+
analysis:
22+
name: Scorecard analysis
23+
runs-on: ubuntu-latest
24+
permissions:
25+
# Needed to upload the results to code-scanning dashboard.
26+
security-events: write
27+
# Needed to publish results and get a badge (see publish_results below).
28+
id-token: write
29+
30+
steps:
31+
- name: "Checkout code"
32+
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
33+
with:
34+
persist-credentials: false
35+
36+
- name: "Run analysis"
37+
uses: ossf/scorecard-action@e38b1902ae4f44df626f11ba0734b14fb91f8f86 # v2.1.2
38+
with:
39+
results_file: results.sarif
40+
results_format: sarif
41+
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
42+
# - you have Branch Protections set (it doesn't apply to the new Repo Rules, as they don't require a PAT to be accessed) and want to enable the Branch-Protection check
43+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
44+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
45+
46+
47+
# - Publish results to OpenSSF REST API for easy access by consumers
48+
# - Allows the repository to include the Scorecard badge.
49+
# - See https://github.com/ossf/scorecard-action#publishing-results.
50+
publish_results: true
51+
52+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
53+
# format to the repository Actions tab.
54+
- name: "Upload artifact"
55+
uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
56+
with:
57+
name: SARIF file
58+
path: results.sarif
59+
retention-days: 5
60+
61+
# Upload the results to GitHub's code scanning dashboard.
62+
- name: "Upload to code-scanning"
63+
uses: github/codeql-action/upload-sarif@17573ee1cc1b9d061760f3a006fc4aac4f944fd5 # v2.2.4
64+
with:
65+
sarif_file: results.sarif

0 commit comments

Comments
 (0)