ci.yml

name: Continuous Integration

on: 
  push: 
    branches: [ main ]
  pull_request:
  schedule:
    - cron:  "0 3 * * 1" # Run every Monday 3 am

jobs:
  ci:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: write
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12"]
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install uv
        uses: astral-sh/setup-uv@v4
        with:
          version: "0.5.10"

      - name: Install tkinter for GUI
        run: sudo apt install python3-tk -y

      - name: Set up env
        run: uv sync --all-extras --frozen

      - name: Run ruff format
        run: uv run ruff format

      - name: Run ruff linter for mdp folder
        run: uv run ruff check src/behavior_generation_lecture_python/mdp

      - name: Run mypy for mdp folder
        run: uv run mypy src/behavior_generation_lecture_python/mdp

      - name: Test
        run: |
          export DISPLAY=:99
          Xvfb :99 &
          uv run pytest

      - name: Check coverage
        run: |
          export DISPLAY=:99
          Xvfb :99 &
          uv run pytest --cov=src --cov-fail-under=85

  pr-docs:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    needs: ci
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Install uv
        uses: astral-sh/setup-uv@v4
        with:
          version: "0.5.10"

      - name: Install tkinter for GUI
        run: sudo apt install python3-tk -y

      - name: Set up env
        run: uv sync --all-extras --frozen

      - name: Copy notebooks to docs folder
        run: cp -r notebooks/* docs/notebooks

      - name: Build PR docs (including running the notebooks)
        run: |
          sed -i "s/^site_name:.*$/site_name: 'Behavior Generation Lecture - tmp docs for PR ${{ github.event.pull_request.number }}'/" mkdocs.yml
          uv run ipython kernel install --user --name=behavior_generation_lecture
          uv run mkdocs build --site-dir site/pr-${{ github.event.pull_request.number }}

      - name: Deploy PR docs
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: site/pr-${{ github.event.pull_request.number }}
          destination_dir: pr-${{ github.event.pull_request.number }} # Deploy to subdirectory
          publish_branch: gh-pages
          keep_files: true # Retain other content on gh-pages

      - name: Add PR note
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          message: |
            ### :books: Docs

            Created [temporary docs](https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-${{ github.event.pull_request.number }}/).