Merge pull request #17 from atsign-foundation/cpswan-ossf-scorecard

feat: Add OpenSSF scorecard

.github/workflows/scorecards.yml

@@ -0,0 +1,72 @@
+# 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: 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: '22 4 * * 6'
+  push:
+    branches: [ "trunk" ]
+
+# 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@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) Read-only 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_READ_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@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        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@3ab4101902695724f9365a384f86c1074d94e18c # v3.24.7
+        with:
+          sarif_file: results.sarif

README.md

@@ -1,30 +1,42 @@
 <a href="https://atsign.com#gh-light-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only" alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only" alt="The Atsign Foundation"></a>
 
+[![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/docs/badge)](https://securityscorecards.dev/viewer/?uri=github.com/atsign-foundation/docs&sort_by=check-score&sort_direction=desc)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8681/badge)](https://www.bestpractices.dev/projects/8681)
+
 # Docs
 
-This repo contains all of our open-source developer documentation which syncs with [GitBook](https://www.gitbook.com/).
+This repo contains all of our open-source developer documentation which syncs
+with [GitBook](https://www.gitbook.com/).
 
 ## Who is this for?
 
-Our goal is to make sure that this repo has the A -> Z of everything that you need to develop with the atPlatform.
+Our goal is to make sure that this repo has the A -> Z of everything that you
+need to develop with the atPlatform.
 
-If you are a developer, this is for you! Come join us, and help us improve the content and experience. We are always learning from you.
+If you are a developer, this is for you! Come join us, and help us improve
+the content and experience. We are always learning from you.
 
 ## What can you find in this repo?
 
-If you are new to the atPlatform, learn about how the platform works and how this can make such a big difference for you by cutting down on time to develop and market applications.
+If you are new to the atPlatform, learn about how the platform works and how
+this can make such a big difference for you by cutting down on time to develop
+and market applications.
 
-The site gives you all the tools, samples, examples and documentation needed to get started on the atPlatform and SDK. The site also provides access to the various communities where you can collaborate and talk to other developers working on the platform.
+The site gives you all the tools, samples, examples and documentation needed
+to get started on the atPlatform and SDK. The site also provides access to
+the various communities where you can collaborate and talk to other developers
+working on the platform.
 
 ## Visit the actual site
 
-> Coming Soon!
-
-For now, visit our existing site [here](https://docs.atsign.com/).
+The contents of this repo are published at
+[https://docs.atsign.com/](https://docs.atsign.com/).
 
 ## How can you contribute?
 
-If you think there should be a change made, or think there could be anything done better, feel free to open a pull request to the trunk branch!
+If you think there should be a change made, or think there could be anything
+done better, feel free to open a pull request to the trunk branch!
 
 Take a look at [CONTRIBUTING.md](CONTRIBUTING.md) for further instructions.