testing.yml

name: testing

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

jobs:
  tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10"]

    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0  # setuptools-scm

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

    - name: Checkout spgrep
      uses: actions/checkout@v4
      with:
        repository: spglib/spgrep
        ref: 'develop'
        path: "spgrep"
        fetch-depth: 0  # setuptools-scm

    - name: Install spgrep
      working-directory: "spgrep"
      run: |
        python -m pip install --upgrade pip
        python -m pip install -e .

    - name: Install
      run: |
        python -m pip install -e .[dev]

    - name: Test with pytest
      run: |
        python -m pytest -v --cov=src/spgrep_modulation --cov-config=setup.cfg --cov-report=xml tests/

    - name: Upload coverage to Codecov
      if: matrix.python-version == '3.9'
      uses: codecov/codecov-action@v4
      with:
        file: ./coverage.xml
        flags: unittests
        fail_ci_if_error: false

  docs:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0

    - uses: actions/setup-python@v5
      with:
        python-version: "3.9"

    - name: Install dependencies
      run: |
        sudo apt-get install -y pandoc

    - name: Install
      run: |
        python -m pip install --upgrade pip
        pip install -e .[dev,docs]

    - name: Build
      run: |
        sphinx-build docs docs_build

    - name: Deploy docs at develop branch
      if: ${{ github.event.pull_request.merged || (github.ref == 'refs/heads/develop') }}
      uses: peaceiris/actions-gh-pages@v4
      with:
        deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        publish_dir: ./docs_build
        destination_dir: develop