python-package-reusable.yml

name: Reusable Python Package CI

on:
  workflow_call:
    inputs:
      privileged:
        description: 'Run tests with sudo (for tests requiring root privileges)'
        required: false
        default: false
        type: boolean

jobs:
  ut:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13"]

    steps:
    - uses: actions/checkout@v5
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev]"
    - name: Install npm dependencies
      run: |
        if [ -f package.json ]; then npm install; fi
        echo "$GITHUB_WORKSPACE/node_modules/.bin/" >> $GITHUB_PATH
    - name: Install apt dependencies
      run: |
        if [ -f packages.txt ]; then cat packages.txt | xargs sudo apt-get install -y; fi
    - name: Run CI setup script
      run: |
        if [ -f ci-setup.sh ]; then sudo bash ci-setup.sh; fi
    - name: Test with pytest
      env:
        TERM: xterm
      run: |
        if [ "${{ inputs.privileged }}" = "true" ]; then
          sudo env "PATH=$PATH" pytest -v
        else
          pytest -v
        fi
    - uses: actions/upload-artifact@v4
      if: failure()
      with:
        name: test-artifacts-${{ matrix.python-version }}
        path: test/

  build_doc:
    runs-on: ubuntu-latest

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

    - name: Build docs
      run: |
        pip install -e .
        pip install mkdocs mkdocs-material "mkdocstrings[python]"
        mkdocs build

  lint:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v5

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

    - name: Lint with ruff
      run: |
        pip install ruff
        ruff check .
        ruff format --check .