From 113cd0b99bc8c58857ff0052327b6aaa22f1ce5e Mon Sep 17 00:00:00 2001 From: Michael Beale Date: Fri, 26 Jul 2024 14:55:59 -0700 Subject: [PATCH] Ossf scorecard updates (#24) * Update scorecard.yml Cleaned up some extraneous comments and updated actions to latest versions. * Update README.md Adding CodeQL and OSSF Scorecard Badges to readme. --- .github/workflows/scorecard.yml | 31 +++---------------------------- README.md | 3 +++ 2 files changed, 6 insertions(+), 28 deletions(-) diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml index 91a9611..1970c7c 100644 --- a/.github/workflows/scorecard.yml +++ b/.github/workflows/scorecard.yml @@ -28,48 +28,23 @@ jobs: 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 + uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: persist-credentials: false - name: "Run analysis" - uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1 + uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0 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/upload-artifact@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20 + uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 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@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9 - with: - sarif_file: results.sarif diff --git a/README.md b/README.md index 770153d..7e4a963 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # HERACLES Polynomial Instruction Set Architecture Tools +[![CodeQL](https://github.com/ossf/scorecard-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/intellabs/hec-p-isa-tools/actions/workflows/codeql-analysis.yml) +[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/intellabs/hec-p-isa-tools/badge)](https://scorecard.dev/viewer/?uri=github.com/intellabs/hec-p-isa-tools) + ## Overview Intel’s [HERACLES accelerator technology](https://dl.acm.org/doi/10.1145/3560810.3565290) aims at improving the computational performance of