deploy-docs.yml

name: Deploy API Reference
on:
  push:
    branches:
      - "!dependabot/**"
      - "*"
jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - uses: actions/setup-python@v3
        name: Ensure Python Runtime
        with:
          python-version: '3.x'
          architecture: 'x64'

      - name: Ensure PDM
        run: |
          python3 -m pip install pdm

      - name: Install Package
        run: |
          pdm install

      - name: Build with MKDocs
        run: |
          pdm run mkdocs build

      - name: Deploy to Netlify
        uses: nwtgck/actions-netlify@v1
        with:
          publish-dir: './site'
          production-branch: master
          github-token: ${{ secrets.GITHUB_TOKEN }}
          deploy-message: "Deploy from GitHub Actions"
          github-deployment-environment: preview
          enable-pull-request-comment: true
          enable-commit-comment: false
          overwrites-pull-request-comment: true
        env:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
        timeout-minutes: 1