box2d-docs-github.yml

# More GitHub Actions for Azure: https://github.com/Azure/actions

name: Build Box2D Docs for GitHub Pages

env:
  COMMON_SETTINGS_PATH: docs/docfx.json

on:
  workflow_dispatch:

jobs:
  publish-docs:
    runs-on: windows-latest

    steps:
    - name: .NET SDK Setup
      uses: actions/setup-dotnet@v5
      with:
        dotnet-version: 10.x

    - name: Checkout Box2D.NET
      uses: actions/checkout@v6

    - name: Run Box2D.NET.CommentConverter.csproj
      run: dotnet run --project tools/Box2D.NET.CommentConverter/Box2D.NET.CommentConverter.csproj --configuration Release --framework net9.0

    - name: Install DocFX
      # This installs the latest version of DocFX and may introduce breaking changes
      # run: dotnet tool update -g docfx
      # This installs a specific, tested version of DocFX.
      run: dotnet tool update -g docfx --version 2.78.2

    - name: Build Box2D.NET API Docs
      run: docfx metadata ${{ env.COMMON_SETTINGS_PATH }}

    - name: Build Box2D.NET Docs
      run: docfx build ${{ env.COMMON_SETTINGS_PATH }}

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v4.0.0
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_site
        publish_branch: gh-pages