code-quality.yml

name: Code Quality

# Only run on branches (e.g. not tags)
on:
  push:
    branches:
      - "*"
  pull_request:
    branches:
      - "*"

jobs:
  formatting:
    name: Formatting
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install deps
        run: python -m pip install ruff clang-format

      - name: Run formatting checks
        run: python dev/formatting.py --check

  static-analysis:
    name: Static Analysis
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install ruff
        run: python -m pip install ruff

      - name: Run ruff
        run: ruff check

  type-checking:
    name: Type Checking
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install MyPy
        run: pip install mypy hypothesis pytest numpy

      - name: Run MyPy
        run: |
          python -m pip install --editable .
          mypy --strict tests

  package-validation:
    name: Package Validation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install Validators
        run: python -m pip install twine build

      - name: Run Validation
        run: |
          python -m build
          twine check dist/*

  warning-free-compilation:
    name: Warning-free Compilation
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        # Note, clang is used on macos, even though it says gcc
        os: [ubuntu-latest, windows-latest, macos-latest]

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

      - name: Set up Python 3.12
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install build

      - name: Set Environment
        run: echo FN_WARNINGS_AS_ERRORS=1 >> $GITHUB_ENV

      - name: Compile
        run: python -m build --wheel