codeql.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
---
name: "CodeQL"

on:  # yamllint disable-line rule:truthy
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    # Run weekly on Sunday at 07:13 UTC. Off-peak hour chosen so the job
    # doesn't collide with Monday-morning CI surges.
    - cron: "13 7 * * 0"

permissions:
  contents: read

jobs:
  analyze:
    name: "Analyze (${{ matrix.language }})"
    runs-on: ubuntu-24.04
    permissions:
      # Writing security-events is required for CodeQL to upload results to
      # the repository's "Security" tab. The rest stay read-only.
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        # `python` covers the hand-written tools under `tools/`. `actions`
        # is CodeQL's GitHub-Actions analyser — it inspects the workflow
        # YAML in `.github/workflows/` for taint flows, secret exposure,
        # and other CI-side vulnerabilities. It complements `zizmor.yml`
        # (lint-style ruleset) with the deeper data-flow analysis.
        language: [python, actions]

    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
        with:
          persist-credentials: false

      - name: Initialize CodeQL
        uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e  # v4.36.2
        with:
          languages: ${{ matrix.language }}
          # Neither the Python tools (stdlib-only / single OAuth dep, no
          # untrusted network input at runtime) nor the workflow YAML
          # warrants `security-extended`; the default
          # `security-and-quality` suite is sufficient for both.
          queries: security-and-quality

      - name: Perform CodeQL analysis
        uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e  # v4.36.2
        with:
          category: "/language:${{ matrix.language }}"