Skip to content

Commit 9eb5ab4

Browse files
inigomarquinezctcpip
authored andcommitted
chore: add support for OSSF scorecard reporting (expressjs#522)
PR-URL: expressjs#522
1 parent fccaf48 commit 9eb5ab4

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

.github/workflows/scorecard.yml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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: '16 21 * * 1'
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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.2
33+
with:
34+
persist-credentials: false
35+
36+
- name: "Run analysis"
37+
uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
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 want to enable the Branch-Protection check on a *public* repository, or
43+
# - you are installing Scorecard on a *private* repository
44+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
45+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
46+
47+
# Public repositories:
48+
# - Publish results to OpenSSF REST API for easy access by consumers
49+
# - Allows the repository to include the Scorecard badge.
50+
# - See https://github.com/ossf/scorecard-action#publishing-results.
51+
# For private repositories:
52+
# - `publish_results` will always be set to `false`, regardless
53+
# of the value entered here.
54+
publish_results: true
55+
56+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
57+
# format to the repository Actions tab.
58+
- name: "Upload artifact"
59+
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
60+
with:
61+
name: SARIF file
62+
path: results.sarif
63+
retention-days: 5
64+
65+
# Upload the results to GitHub's code scanning dashboard.
66+
- name: "Upload to code-scanning"
67+
uses: github/codeql-action/upload-sarif@2f93e4319b2f04a2efc38fa7f78bd681bc3f7b2f # v2.23.2
68+
with:
69+
sarif_file: results.sarif

0 commit comments

Comments
 (0)