Ceres/.github/workflows/documentation.yml at 9e368ee46d3715ef61e6d6a8ffca3fa55abe40f8 · AkiKurisu/Ceres · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
name: Deploy documentation

on:
  push:
    branches:
      - main
    paths:
      - 'Documentations/**'
      - '.github/workflows/documentation.yml'
  # Allow manual runs from the Actions tab
  workflow_dispatch:

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

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued. Do not cancel in-progress runs.
concurrency:
  group: pages
  cancel-in-progress: false

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@v4

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

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

      # API metadata requires Unity's compiled assemblies and XML documentation.
      # It is committed to the repository and regenerated locally with
      # Documentations/tools/generate-api.ps1 -UnityEditorPath <editor-executable>
      # when the public API changes.
      - name: Build DocFX Documentation
        run: docfx build Documentations/docfx.json

      - name: Remove local build metadata
        run: rm -f Site/manifest.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