feat: add OSSF Scorecard action and badge

.github/workflows/scorecards.yml

@@ -0,0 +1,68 @@
+name: Scorecards 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: '23 2 * * 5'
+    push:
+        branches: ['master']
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+    analysis:
+        name: Scorecards 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@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+              with:
+                  persist-credentials: false
+
+            - name: 'Run analysis'
+              uses: ossf/scorecard-action@99c53751e09b9529366343771cc321ec74e9bd3d # v2.0.6
+              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 Scorecards on a *private* repository
+                  # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+                  # 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@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+              with:
+                  name: SARIF file
+                  path: results.sarif
+                  retention-days: 5
+
+            # Upload the results to GitHub's code scanning dashboard.
+            - name: 'Upload to code-scanning'
+              uses: github/codeql-action/upload-sarif@807578363a7869ca324a79039e6db9c843e0e100 # v2.1.27
+              with:
+                  sarif_file: results.sarif

README.md

@@ -8,6 +8,7 @@ Automated Accessibility Testing Libraries and Tools ([@sa11y packages](https://w
 [![License](https://img.shields.io/npm/l/@sa11y/common)](./LICENSE.txt)
 [![NPM downloads per month of @sa11y/common package](https://img.shields.io/npm/dm/@sa11y/common)](https://www.npmtrends.com/@sa11y/common)
 [![Known Vulnerabilities](https://snyk.io/test/github/salesforce/sa11y/badge.svg?targetFile=package.json)](https://snyk.io/test/github/salesforce/sa11y?targetFile=package.json)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/salesforce/sa11y/badge)](https://api.securityscorecards.dev/projects/github.com/salesforce/sa11y)
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->