Skip to content

Commit 2081f29

Browse files
authored
ENH: Add OpenSSF Scorecard GitHub Action (numpy#22482)
[skip azp][skip circle]
1 parent d2d6c39 commit 2081f29

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

.github/workflows/scorecards.yml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Scorecards supply-chain security
2+
on:
3+
# For Branch-Protection check. Only the default branch is supported. See
4+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
5+
branch_protection_rule:
6+
# To guarantee Maintained check is occasionally updated. See
7+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
8+
schedule:
9+
- cron: "19 23 * * 5"
10+
push:
11+
branches: ["main"]
12+
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
16+
jobs:
17+
analysis:
18+
name: Scorecards analysis
19+
runs-on: ubuntu-latest
20+
permissions:
21+
# Needed to upload the results to code-scanning dashboard.
22+
security-events: write
23+
# Needed to publish results and get a badge (see publish_results below).
24+
id-token: write
25+
26+
steps:
27+
- name: "Checkout code"
28+
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
29+
with:
30+
persist-credentials: false
31+
32+
- name: "Run analysis"
33+
uses: ossf/scorecard-action@99c53751e09b9529366343771cc321ec74e9bd3d # v2.0.6
34+
with:
35+
results_file: results.sarif
36+
results_format: sarif
37+
# Publish results to OpenSSF REST API for easy access by consumers.
38+
# Allows the repository to include the Scorecard badge.
39+
# See https://github.com/ossf/scorecard-action#publishing-results.
40+
publish_results: true
41+
42+
# Upload the results as artifacts (optional). Commenting out will disable
43+
# uploads of run results in SARIF format to the repository Actions tab.
44+
- name: "Upload artifact"
45+
uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
46+
with:
47+
name: SARIF file
48+
path: results.sarif
49+
retention-days: 5
50+
51+
# Upload the results to GitHub's code scanning dashboard.
52+
- name: "Upload to code-scanning"
53+
uses: github/codeql-action/upload-sarif@807578363a7869ca324a79039e6db9c843e0e100 # v2.1.27
54+
with:
55+
sarif_file: results.sarif

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ https://anaconda.org/conda-forge/numpy)
1313
https://stackoverflow.com/questions/tagged/numpy)
1414
[![Nature Paper](https://img.shields.io/badge/DOI-10.1038%2Fs41592--019--0686--2-blue)](
1515
https://doi.org/10.1038/s41586-020-2649-2)
16+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/numpy/numpy/badge)](https://api.securityscorecards.dev/projects/github.com/numpy/numpy)
17+
1618

1719
NumPy is the fundamental package for scientific computing with Python.
1820

0 commit comments

Comments
 (0)