documentation.yml

name: Deploy documentation

on:
  push:
    branches:
      - main

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

jobs:
  # Build the documentation
  build:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup .NET SDK
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: '7.0.x'

      - name: Install DocFX
        run: dotnet tool update -g --version 2.61.0 docfx

      - name: Build DocFX Documentation
        run: docfx Documentation~/docfx.json

      - name: Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site~/

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