codeql.yml

name: "CodeQL"

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
  schedule:
    - cron: "46 2 * * 5"

  # Allow job to be triggered manually.
  workflow_dispatch:

# Cancel in-progress jobs when pushing to the same branch.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:

  analyze:
    name: "Analyze Python code"
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        language: [ python ]

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
          architecture: x64
          cache: 'pip'
          cache-dependency-path: |
            setup.py

      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          version: "latest"

      - name: Initialize CodeQL
        uses: github/codeql-action/init@v3
        with:
          languages: ${{ matrix.language }}
          config-file: ./.github/codeql.yml
          queries: +security-and-quality
          # run an 'alert-suppression' query
          packs: "codeql/${{ matrix.language }}-queries:AlertSuppression.ql"

      #- name: Autobuild
      #  uses: github/codeql-action/autobuild@v2

      - name: Install project
        run: |
          uv pip install --system '.[test]'

      - name: Perform CodeQL Analysis
        id: analyze
        uses: github/codeql-action/analyze@v3
        with:
          category: "/language:${{matrix.language}}"
          # define the output folder for SARIF files
          output: sarif-results

      # Unlock inline mechanism to suppress CodeQL warnings.
      # https://github.com/github/codeql/issues/11427#issuecomment-1721059096
      - name: Dismiss alerts
        # if: github.ref == 'refs/heads/main'
        uses: advanced-security/dismiss-alerts@v1
        with:
          # specify a 'sarif-id' and 'sarif-file'
          sarif-id: ${{ steps.analyze.outputs.sarif-id }}
          sarif-file: sarif-results/${{ matrix.language }}.sarif
        env:
          GITHUB_TOKEN: ${{ github.token }}