docs.yml

name: .NET Docs
on:
  release:
    types:
      - published
  workflow_dispatch:
  push:
    paths:
      - 'docs/**'
      - 'src/**'
      - 'libs/**'
      - '.github/workflows/docs.yml'
    branches:
      - master

env:
  DOTNET_NOLOGO: 1
  DOTNET_CLI_TELEMETRY_OPTOUT: 1
  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
  DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1

permissions:
  contents: write

jobs:
  generate-docs:
    name: Generate Docs
    runs-on: ubuntu
    if: "!contains(format('{0} {1}', github.event.head_commit.message, github.event.pull_request.title), '[ci-skip]')"
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: '0'
          submodules: recursive
      - name: Setup .NET
        uses: actions/setup-dotnet@v3
        with:
          dotnet-version: 7
      - name: Install DocFX
        run: dotnet tool install -g docfx
        continue-on-error: true
      - name: Build documentation
        run: docfx docs/docfx.json
      - name: Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Path of the directory containing the static assets.
          path: ./docs/_site/ # default is _site/

  deploy:
    name: Deploy to GitHub Pages
    # Add a dependency to the build job
    needs: generate-docs
    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment, originates from an appropriate source
    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    # Specify runner + deployment step
    runs-on: ubuntu
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1