docs.yml

name: 📚 Docs

on:
  push:
    branches:
    - main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  actions: read
  pages: write
  id-token: write

# 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:
  publish-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true
    - name: ⚙ Install prerequisites
      run: ./init.ps1 -UpgradePrerequisites

    - run: dotnet docfx docfx/docfx.json
      name: 📚 Generate documentation

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: docfx/_site

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