docs.yml

name: Publish mkdocs via GitHub Pages
on:
  push:
    branches:
      - main

  workflow_dispatch:
  repository_dispatch:
    types: [deploy]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions: write-all

  # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
  # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout main
        uses: actions/checkout@v3

      - name: Generate docs
        uses: jmoney/gha-mkdocs-personal@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: './site'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2