Skip to content

Commit

Permalink
Merge pull request #721 from shinybrar/main
Browse files Browse the repository at this point in the history
[CADC-13809] Implement a OpenSSF Scorecard
  • Loading branch information
at88mph authored Nov 5, 2024
2 parents 55148e9 + c67cb9a commit 2a9c323
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 12 deletions.
73 changes: 73 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# 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: 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:
# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- cron: '37 23 * * 3'
push:
branches: [ "main" ]

# Declare default permissions as read only.
permissions: read-all

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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
persist-credentials: false

- name: "Run analysis"
uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
with:
results_file: results.sarif
results_format: sarif
# (Optional) "write" PAT 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?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
# repo_token: ${{ secrets.SCORECARD_TOKEN }}

# Public repositories:
# - Publish results to OpenSSF REST API for easy access by consumers
# - Allows the repository to include the Scorecard badge.
# - See https://github.com/ossf/scorecard-action#publishing-results.
# For private repositories:
# - `publish_results` will always 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/[email protected] # v4.4.3
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@v3
with:
sarif_file: results.sarif
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@

# skaha - A Container-based Science Platform in CANFAR

#### Table of contents
* [User Documentation](#canfar-science-portal-documentation)
* [Acknowledgements](#acknowledgements)
* [Overview](#overview)
* [System Components](#system-components)
* [Session Containers](#session-containers)
* [Software Containers](#software-containers)
* [Dependencies](#dependencies)
* [Deployment](#deployment)
# Skaha

*A container based science platform in CANFAR.*

---

[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/opencadc/science-platform/badge)](https://scorecard.dev/viewer/?uri=github.com/opencadc/science-platform)

## Table of Contents
- [Skaha](#skaha)
- [Table of Contents](#table-of-contents)
- [CANFAR Science Portal Documentation](#canfar-science-portal-documentation)
- [Acknowledgements](#acknowledgements)
- [Overview](#overview)
- [Helm Installation](#helm-installation)
- [System Components](#system-components)
- [skaha](#skaha-1)
- [Session Containers](#session-containers)
- [Software Containers](#software-containers)
- [Dependencies](#dependencies)
- [Deployment](#deployment)

## CANFAR Science Portal Documentation

Expand Down

0 comments on commit 2a9c323

Please sign in to comment.