docs-preview.yml

name: docs-preview
on:
  - pull_request

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          lfs: true

      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
          cache: pip
          cache-dependency-path: "pyproject.toml"

      - name: Install dependencies
        run: |
          pip install flit
          pip install ".[doc]"

      - name: Build documentation
        run: mkdocs build -f ./mkdocs.yml

      - name: Deploy to Netlify
        uses: nwtgck/actions-netlify@v1.1
        id: deployment
        with:
          publish-dir: "./site"
          production-branch: master
          github-token: ${{ secrets.GITHUB_TOKEN }}
          deploy-message: "#${{ github.event.number }}: ${{ github.event.pull_request.title }}"
          enable-pull-request-comment: true
          enable-commit-comment: false
          overwrites-pull-request-comment: true
          alias: docs-preview-${{ github.event.number }}
        env:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
        timeout-minutes: 1