ci.yml

name: CI

on:
    push:
        branches:
            - main
            - dev
    pull_request:
        branches:
            - main
            - dev
    
    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:

jobs:
    
    Linting:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: ['3.8', '3.9', '3.10', '3.11']
        steps:
            -   uses: actions/checkout@v2
            -   name: Set up Python ${{ matrix.python-version }}
                uses: actions/setup-python@v2
                with:
                    python-version: ${{ matrix.python-version }}
                    
            -   name: Poetry cache
                uses: actions/cache@v3
                with:
                    path: ~/.cache/pypoetry
                    key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}

            -   name: Install Poetry
                uses: snok/install-poetry@v1

            -   name: Install Dependencies
                # TODO: fix errors so that we can run `make dev` instead
                run: |
                    make full

            -   name: Lint with isort, black, docformatter, flake8
                run: |
                    make lint

    Typing:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: ['3.8', '3.9', '3.10', '3.11']
                pydantic-version: ['1.10.9', '2.4.2']
                openai-version: ['0.28.1', '1.2.4']
        steps:
            -   uses: actions/checkout@v2
            -   name: Set up Python ${{ matrix.python-version }}
                uses: actions/setup-python@v2
                with:
                    python-version: ${{ matrix.python-version }}

            -   name: Poetry cache
                uses: actions/cache@v3
                with:
                    path: ~/.cache/pypoetry
                    key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}

            -   name: Install Poetry
                uses: snok/install-poetry@v1

            -   name: Install Dependencies
                # TODO: fix errors so that we can run `make dev` instead
                run: |
                    make full
                    poetry run pip install pydantic==${{ matrix.pydantic-version }}
                    poetry run pip install openai==${{ matrix.openai-version }}

            -   if: matrix.pydantic-version == '2.4.2' && matrix.openai-version == '0.28.1'
                name: Static analysis with pyright (ignoring pydantic v1 and openai v1)
                run: |
                    make type-pydantic-v2-openai-v0

            -   if: matrix.pydantic-version == '1.10.9' && matrix.openai-version == '0.28.1'
                name: Static analysis with mypy (ignoring pydantic v2 and openai v1)
                run: |
                    make type-pydantic-v1-openai-v0

            -   if: matrix.pydantic-version == '2.4.2' && matrix.openai-version == '1.2.4'
                name: Static analysis with pyright (ignoring pydantic v1 and openai v0)
                run: |
                    make type-pydantic-v2-openai-v1

            -   if: matrix.pydantic-version == '1.10.9' && matrix.openai-version == '1.2.4'
                name: Static analysis with mypy (ignoring pydantic v2 and openai v0)
                run: |
                    make type-pydantic-v1-openai-v1

    Pytests:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: ['3.8', '3.9', '3.10', '3.11']
                # TODO: fix errors so that we can run both `make dev` and `make full`
                # dependencies: ['dev', 'full']
                dependencies: ['full']
                pydantic-version: ['1.10.9', '2.4.2']
                openai-version: ['0.28.1', '1.2.4']
        steps:
            -   uses: actions/checkout@v2
            -   name: Set up Python ${{ matrix.python-version }}
                uses: actions/setup-python@v2
                with:
                    python-version: ${{ matrix.python-version }}
                    
            -   name: Poetry cache
                uses: actions/cache@v3
                with:
                    path: ~/.cache/pypoetry
                    key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}-${{ matrix.openai-version }}

            -   name: Install Poetry
                uses: snok/install-poetry@v1

            -   name: Install Dependencies
                run: |
                    make ${{ matrix.dependencies }}
                    poetry run pip install pydantic==${{ matrix.pydantic-version }}
                    poetry run pip install openai==${{ matrix.openai-version }}

            -   name: Run Pytests
                run: |
                    make test-cov

            -   name: Upload to codecov.io
                uses: codecov/codecov-action@v3
                with:
                    token: ${{ secrets.CODECOV_TOKEN }}
                    file: ./coverage.xml
                    flags: unittests
                    name: codecov-umbrella
                    fail_ci_if_error: true
    
    Notebooks:
        runs-on: ubuntu-latest
        if: ${{ always() && contains(join(needs.*.result, ','), 'success') }}
        needs: [Linting, Typing, Pytests]
        
        env:
          COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}


        steps:
        - name: Checkout repository
          uses: actions/checkout@v2

        - name: Set up Python
          uses: actions/setup-python@v2
          with:
            python-version: 3.11.x

        - name: Poetry cache
          uses: actions/cache@v3
          with:
            path: ~/.cache/pypoetry
            key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}

        - name: Install Poetry
          uses: snok/install-poetry@v1
          with:
              virtualenvs-create: true
              virtualenvs-in-project: true
              installer-parallel: true

        - name: Install dependencies
          run: |
            make full;
            poetry add openai==0.28.1 jupyter nbconvert cohere;
            # pip install openai==0.28.1 jupyter nbconvert;
            # pip install .;

        - name: Check for pypdfium2
          run: poetry run pip show pypdfium2

        - name: Execute notebooks and check for errors
          run: |
            cd docs/examples
            for notebook in $(ls *.ipynb); do
              if [ "$notebook" != "valid_chess_moves.ipynb" ] && [ "$notebook" != "translation_with_quality_check.ipynb" ]; then
                poetry run jupyter nbconvert --to notebook --execute "$notebook"
                if [ $? -ne 0 ]; then
                    echo "Error found in $notebook"
                    exit 1
                fi
              fi
            done