From 1346804b10affc0038b18787dde1ddd81c415763 Mon Sep 17 00:00:00 2001
From: Abhishek Anand <raianand@users.noreply.github.com>
Date: Fri, 26 Jul 2024 17:58:06 +0530
Subject: [PATCH] added ossf scorecard workflow (#63)

* added ossf scorecard workflow

* changed condition to main branch
---
 .github/workflows/ossf-scorecard.yml | 69 ++++++++++++++++++++++++++++
 .gitignore                           |  4 +-
 2 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/ossf-scorecard.yml

diff --git a/.github/workflows/ossf-scorecard.yml b/.github/workflows/ossf-scorecard.yml
new file mode 100644
index 0000000..1070608
--- /dev/null
+++ b/.github/workflows/ossf-scorecard.yml
@@ -0,0 +1,69 @@
+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: '18 17 * * 6'
+  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: false
+
+      # 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
+    #     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/.gitignore b/.gitignore
index 50f5f68..608b9c7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -104,4 +104,6 @@ __tests__/runner/*
 
 bin/
 
-src/generated/
\ No newline at end of file
+src/generated/
+
+audit.json
\ No newline at end of file