OSSAR #120
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
| ### | |
| # ```{rubric} OSSAR | |
| # ``` | |
| # --- | |
| # 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. | |
| # | |
| # This workflow integrates a collection of open source static analysis tools | |
| # with GitHub code scanning. For documentation, or to provide feedback, visit | |
| # https://github.com/github/ossar-action | |
| # | |
| # ```{literalinclude} /.github/workflows/ossar.yml | |
| # :language: yaml | |
| # :start-at: "name: OSSAR\n" | |
| # :end-before: "###\n" | |
| # ``` | |
| name: OSSAR | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| ### | |
| # The branches below must be a subset of the branches above | |
| branches: [ "main" ] | |
| schedule: | |
| - cron: '43 10 * * 4' | |
| ### | |
| # ```{rubric} OSSAR Jobs | |
| # ``` | |
| # --- | |
| # Define the jobs necessary for a useful ossar run. | |
| # | |
| # ```{literalinclude} /.github/workflows/ossar.yml | |
| # :language: yaml | |
| # :start-at: "jobs:\n" | |
| # ``` | |
| jobs: | |
| OSSAR-Scan: | |
| ### | |
| # OSSAR runs on windows-latest. | |
| # ubuntu-latest and macos-latest support coming soon | |
| permissions: | |
| ### | |
| # for actions/checkout to fetch code | |
| contents: read | |
| ### | |
| # for github/codeql-action/upload-sarif to upload SARIF results | |
| security-events: write | |
| ### | |
| # only required for a private repository by | |
| # github/codeql-action/upload-sarif to get the Action run status | |
| actions: read | |
| runs-on: windows-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@main | |
| ### | |
| # Ensure a compatible version of dotnet is installed. | |
| # The [Microsoft Security Code Analysis CLI](https://aka.ms/mscadocs) | |
| # is built with dotnet v3.1.201. | |
| # A version greater than or equal to v3.1.201 of dotnet must be installed | |
| # on the agent in order to run this action. | |
| # GitHub hosted runners already have a compatible version of dotnet | |
| # installed and this step may be skipped. | |
| # For self-hosted runners, ensure dotnet version 3.1.201 or later is | |
| # installed by including this action: | |
| # ```{code-block} yaml | |
| # - name: Install .NET | |
| # uses: actions/setup-dotnet@v2 | |
| # with: | |
| # dotnet-version: '3.1.x' | |
| # ``` | |
| # | |
| # Run open source static analysis tools | |
| - name: Run OSSAR | |
| uses: github/ossar-action@main | |
| id: ossar | |
| ### | |
| # Upload results to the Security tab | |
| - name: Upload OSSAR results | |
| uses: github/codeql-action/upload-sarif@main | |
| with: | |
| sarif_file: ${{ steps.ossar.outputs.sarifFile }} |