docs/.github/workflows/build.yml

name: Build and Deploy

env:
  CI: true
  PYTHON_VERSION: '3.7'

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v1
        with:
          python-version: '${{ env.PYTHON_VERSION }}'
          architecture: 'x64'

      - name: Cache dependencies
        uses: actions/cache@v1
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}
          restore-keys: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}

      - name: Install Python dependencies
        run: python3 -m pip install -r requirements.txt

      - name: Build docs
        run: mkdocs build --clean --verbose

      - name: Upload docs
        uses: actions/upload-artifact@v1
        if: success() && github.ref == 'refs/heads/master'
        with:
          name: docs
          path: ./site/

  deploy:
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/master'

    steps:
      - uses: actions/checkout@v2

      - name: Download docs
        uses: actions/download-artifact@v1
        with:
          name: docs
          path: ./site/

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: success()
        with:
          emptyCommits: false
          personal_token: ${{ secrets.PERSONAL_TOKEN }}
          publish_branch: gh-pages
          publish_dir: ./site/