docs.yml

name: Build and Publish Docs

on:
  push:
    branches:
      - master

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

env:
  EXILED_REFERENCES_URL: https://exmod-team.github.io/SL-References/Master.zip
  EXILED_REFERENCES_PATH: ${{ github.workspace }}/EXILED/References

# 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.
# Important due to https://t.ly/5DZAy
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:
    - name: Checkout
      uses: actions/checkout@v4

    - run: dotnet tool update -g docfx

    - name: Setup .NET Core SDK
      uses: actions/setup-dotnet@v4.0.1

    - name: Setup Nuget
      uses: nuget/setup-nuget@v2

    - name: Get references
      shell: pwsh
      run: |
        Invoke-WebRequest -Uri $env:EXILED_REFERENCES_URL -OutFile $env:GITHUB_WORKSPACE/EXILED/References.zip
        Expand-Archive -Path $env:GITHUB_WORKSPACE/EXILED/References.zip -DestinationPath $env:EXILED_REFERENCES_PATH

    - run: docfx EXILED/docs/docfx.json
      env:
        EXILED_REFERENCES: ${{ env.EXILED_REFERENCES_PATH }}

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        # Upload entire repository
        path: 'EXILED/docs/_site'

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