Skip to content

Commit

Permalink
Implement OSSF Scorecard
Browse files Browse the repository at this point in the history
  • Loading branch information
alessfg committed Jan 31, 2024
1 parent 4ca831a commit 4a23e4a
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/rename_project.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ do
done

# This command runs only once on GHA!
rm -rf .github/workflows
rm -f .github/workflows/rename_template.yml
rm -f .github/workflows/rename_project.sh
3 changes: 0 additions & 3 deletions .github/workflows/rename_template.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
name: Rename the template

on:
push:

permissions: write-all

jobs:
rename-template:
if: ${{ !contains(github.repository, 'template') }}
Expand Down
68 changes: 68 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# This workflow uses actions that are not certified by GitHub. They are provided
# by a third-party and are governed by separate terms of service, privacy
# policy, and support documentation.
name: OSSF Scorecard
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:
# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- cron: '30 9 * * 1'
push:
branches: [main, master]
# Declare default permissions as read only.
permissions: read-all
jobs:
analysis:
name: Scorecard analysis
runs-on: ubuntu-22.04
permissions:
# Needed if using Code scanning alerts
security-events: write
# Needed for GitHub OIDC token if publish_results is true
id-token: write
# Uncomment the permissions below if installing in a private repository.
contents: read
actions: read
issues: read # To allow GraphQL ListCommits to work
pull-requests: read # To allow GraphQL ListCommits to work
checks: read # To detect SAST tools
steps:
- name: Check out the codebase
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Run analysis
uses: ossf/[email protected]
with:
results_file: results.sarif
results_format: sarif
# (Optional) fine-grained personal access token. Uncomment the `repo_token` line below if:
# - you want to enable the Branch-Protection check on a *public* repository, or
# - you are installing Scorecard on a *private* repository
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
repo_token: ${{ secrets.SCORECARD_TOKEN }}

# Publish the results for public repositories to enable scorecard badges. For more details, see
# https://github.com/ossf/scorecard-action#publishing-results.
# For private repositories, `publish_results` will automatically be set to `false`, regardless
# of the value entered here.
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.
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: SARIF file
path: results.sarif
retention-days: 5

# Upload the results to GitHub's code scanning dashboard.
- name: Upload SARIF results to code scanning
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: results.sarif

0 comments on commit 4a23e4a

Please sign in to comment.