deploy-documentation.yaml

name: Build and Deploy Pages

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'tools/openapi/**'
      - 'mkdocs.yml'
      - '.github/workflows/**'

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v3
    - uses: actions/setup-python@v4
      with:
        python-version: 3
    - uses: actions/cache@v3
      with:
        key: mkdocs-material-${{ github.ref }} 
        path: .cache
        restore-keys: |
          mkdocs-material-
    - run: pip install mkdocs-material mkdocs-glightbox
    - name: Setup Pages
      id: pages
      uses: actions/configure-pages@v3
    - run: mkdir -p docs/api
    - name: Bundle OpenAPI spec with Redoc
      uses: seeebiii/redoc-cli-github-action@v10
      with:
        args: 'bundle tools/openapi/api.yaml -o docs/api/index.html'
    - run: mkdocs build -d public
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v1
      with:
        path: ./public/

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2