[Code Health] Run Scorecards security analysis #229
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "[Code Health] Run Scorecards security analysis" | |
| on: | |
| # Only the default branch is supported. | |
| branch_protection_rule: | |
| schedule: | |
| - cron: '41 12 * * 3' | |
| 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 | |
| # Used to receive a badge. | |
| id-token: write | |
| # Needs for private repositories. | |
| contents: read | |
| actions: read | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@v2 | |
| with: | |
| egress-policy: audit | |
| # TODO: change to 'egress-policy: block' after auditing a number of runs and updating the allowed-endpoints option accordingly | |
| - name: "Checkout code" | |
| uses: actions/checkout@v4 # tag=v3.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: "Run analysis" | |
| uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # tag=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 }} | |
| # Publish the results for public repositories to enable scorecard badges. For more details, see | |
| # https://github.com/ossf/scorecard-action#publishing-results. | |
| # For private repositories, `publish_results` will automatically 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@694cdabd8bdb0f10b2cea11669e1bf5453eed0a6 # tag=v4.2.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@v3.23.1 # tag=v1.0.26 | |
| with: | |
| sarif_file: results.sarif |