ossar-analysis.yml

---
# SPDX-FileCopyrightText: Microsoft Corporation
#
# SPDX-License-Identifier: MIT
#
# 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

name: "OSSAR"

on: # yamllint disable-line rule:truthy
  push:
    branches: [main, develop, release]
    paths:
      - "src/**"
      - "tests/**"
      - pyproject.toml
      - ".github/workflows/ossar-analysis.yml"

  pull_request:
    # The branches below must be a subset of the branches above
    types: [opened, synchronize, reopened]
    paths:
      - "src/**"
      - "tests/**"
      - pyproject.toml
      - ".github/workflows/ossar-analysis.yml"

  schedule:
    - cron: "22 15 * * 3"

permissions:
  contents: read

jobs:
  OSSAR-Scan:
    # Skip any PR created by dependabot to avoid permission issues:
    if: (github.actor != 'dependabot[bot]')
    # OSSAR runs on windows-latest.
    # ubuntu-latest and macos-latest support coming soon
    permissions:
      contents: read # for actions/checkout to fetch code
      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
    runs-on: windows-latest

    steps:
      - name: "🧰 Checkout Source Code"
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      # 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:
      # - name: Install .NET
      #   uses: actions/setup-dotnet@v1
      #   with:
      #     dotnet-version: '3.1.x'
      # Run open source static analysis tools
      - name: "Run OSSAR"
        uses: github/ossar-action@4e96c4f6e591eb4b991abfd459e40b136a317aea # main
        id: ossar

      # Upload the results to GitHub's code scanning dashboard.
      - name: "Upload to code-scanning"
        uses: github/codeql-action/upload-sarif@f09c1c0a94de965c15400f5634aa42fac8fb8f88 # v3.27.5
        with:
          sarif_file: ${{ steps.ossar.outputs.sarifFile }}