sdv_ci.yaml

name: Test and build

# When does this run - new, reopened or updated PRs and when the workflow is called by
# another workflow, such as the publishing actions.
on:
  pull_request:
    types: [opened, synchronize, reopened]
  workflow_call:


jobs:

  qa:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: "3.10"
      - uses: pre-commit/action@v3.0.0


  test:
    needs: qa
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest, windows-latest ]
        python-version: [ "3.10", "3.11", "3.12" ]

    steps:
    - uses: actions/checkout@v4

    - uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install Poetry
      uses: abatilo/actions-poetry@v2.2.0
      with:
        poetry-version: 1.2.2

    - name: Install dependencies
      run: poetry install

    - name: Run tests
      run: poetry run pytest --cov-report xml


    - name: Upload coverage to Codecov
      if: (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10')
      uses: codecov/codecov-action@v3
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  docs_build:
    needs: qa
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"
    
      - name: Install Poetry
        uses: abatilo/actions-poetry@v2.2.0
        with:
          poetry-version: 1.2.2
    
      - name: Install dependencies
        run: poetry install
          
      - name: Build docs using mkdocs
        run: poetry run mkdocs build --strict

      - name: Check for file modifications due to docs build
        run: |
          if git status | grep -q "modified"; then
            echo "Docs build process has resulted in file changes."
            exit 1
          fi