WebExpress.WebUI/.github/workflows/generate-docs.yml at main · webexpress-framework/WebExpress.WebUI · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
name: Generate and Deploy Documentation

on:
  push:
    branches:
      - main

permissions:
  actions: read
  pages: write
  id-token: write

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 code
      uses: actions/checkout@v3

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

    - name: Install DocFX
      run: dotnet tool install -g docfx

    - name: Add DocFX to PATH
      run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH

    - name: Clone WebExpress.WebCore
      run: |
        git clone --branch develop https://github.com/webexpress-framework/WebExpress.WebCore.git
        mkdir -p packages

    - name: Create wwwroot directory for WebCore
      run: mkdir -p WebExpress.WebCore/src/WebExpress.WebCore/wwwroot

    - name: Build WebExpress.WebCore
      run: |
        dotnet build WebExpress.WebCore/src/WebExpress.WebCore/WebExpress.WebCore.csproj -c Release

    - name: Pack WebExpress.WebCore
      run: |
        dotnet pack WebExpress.WebCore/src/WebExpress.WebCore/WebExpress.WebCore.csproj -c Release -o packages --no-build

    - name: Create nuget.config
      run: |
        echo '<?xml version="1.0" encoding="utf-8"?>' > nuget.config
        echo '<configuration>' >> nuget.config
        echo '  <packageSources>' >> nuget.config
        echo '    <add key="LocalPackages" value="packages" />' >> nuget.config
        echo '    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />' >> nuget.config
        echo '  </packageSources>' >> nuget.config
        echo '</configuration>' >> nuget.config

    - name: Restore packages with local feed
      run: dotnet restore ./src/WebExpress.WebUI/WebExpress.WebUI.csproj --configfile nuget.config

    - name: Build WebExpress.WebUI
      run: dotnet build ./src/WebExpress.WebUI/WebExpress.WebUI.csproj -c Release --no-restore

    - name: Generate documentation
      run: |
        cd docs
        docfx metadata
        docfx build

    - name: Validate JavaScript docs are included in site
      run: |
        test -f docs/_site/js/index.html
        test -f docs/_site/js/webexpress.webui.html

    - name: Generate API toc.yaml
      run: |
        echo "### YamlMime:TableOfContent" > docs/api/toc.yaml
        echo "[" >> docs/api/toc.yaml
        find docs/_site/api -maxdepth 1 -type f -name '*.html' | sort | while read file; do
          name=$(basename "$file" .html)
          echo "  { \"name\": \"$name\", \"href\": \"$name.html\" }," >> docs/api/toc.yaml
        done
        sed -i '$ s/},/}/' docs/api/toc.yaml
        echo "]" >> docs/api/toc.yaml

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: './docs/_site'

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