tests.yml

name: continuous-integration

on:
  push:
    branches: [master]
    tags:
      - 'v*'
  pull_request:
  schedule:
    - cron:  '0 0 * * *'

jobs:

  pre-commit:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.8
      uses: actions/setup-python@v2
      with:
        python-version: 3.8
    - uses: pre-commit/action@v2.0.0

  # for speed, we run a test matrix against only the tests that do not require TeX,
  # then test-with-cov for all tests, for a single environment

  test-with-cov:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.8]

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install wheel
        pip install -e .[testing]

    - name: Install Headless Chrome dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -yq $(cat .github/workflows/pyppeteer_reqs.txt)

    - name: Install latex dependencies
      run: |
        sudo apt-get -qq update
        sudo apt-get install -y   \
          texlive                 \
          texlive-xetex           \
          texlive-latex-extra     \
          texlive-fonts-extra     \
          fonts-freefont-otf      \
          latexmk                 \
          xindy

    - name: Run pytest
      run: |
        pytest --durations=10 --cov=jupyter_book --cov-report=xml --cov-report=term-missing
        coverage xml
      # for some reason the tests/conftest.py::check_nbs fixture breaks pytest-cov's cov-report outputting
      # this is why we run `coverage xml` afterwards (required by codecov)

    - name: Upload to Codecov
      if: github.repository == 'executablebooks/jupyter-book'
      uses: codecov/codecov-action@v1
      with:
        name: ebp-jupyter-book-pytests-py3.8
        flags: pytests
        file: ./coverage.xml
        fail_ci_if_error: true

  tests:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.6, 3.7]
        sphinx: [">=3,<4"]
        include:
          - python-version: 3.8
            sphinx: ">=2,<3"

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install wheel
        pip install "sphinx${{ matrix.sphinx }}"
        pip install -e .[testing]

    - name: Install Headless Chrome dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -yq $(cat .github/workflows/pyppeteer_reqs.txt)

    - name: Run pytest
      run: pytest --durations=10 -m 'not requires_tex'

  windows:

    name: Tests on Windows
    runs-on: windows-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.7
      uses: actions/setup-python@v2
      with:
        python-version: 3.7
    - uses: actions/cache@v2
      with:
        path: ~\AppData\Local\pip\Cache
        key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
        restore-keys: |
          ${{ runner.os }}-pip-
    - name: Install Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install wheel
        pip install --upgrade-strategy eager -e .[testing]
    - name: Run pytest
      run: pytest --durations=10 -m 'not requires_chrome and not requires_tex' --jb-tempdir local_path

  # Build the book on OSX to make sure that building the docs works there too
  build-book-osx:
    name: Build docs on OSX
    runs-on: macos-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.7
      uses: actions/setup-python@v2
      with:
        python-version: 3.7
    - uses: actions/cache@v2
      with:
        path: ~\AppData\Local\pip\Cache
        key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
        restore-keys: |
          ${{ runner.os }}-pip-
    - name: Install Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install wheel
        pip install --upgrade-strategy eager -e .[sphinx]

    - name: Build the book
      run: |
        jb build -W -n --keep-going --builder html docs/

  publish:

    name: Publish to PyPi
    needs: [pre-commit, tests, test-with-cov, build-book-osx]
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v2
      - name: Set up Python 3.7
        uses: actions/setup-python@v1
        with:
          python-version: 3.7
      - name: Build package
        run: |
          pip install wheel
          python setup.py sdist bdist_wheel
      - name: Publish
        uses: pypa/gh-action-pypi-publish@v1.1.0
        with:
          user: __token__
          password: ${{ secrets.PYPI_KEY }}