Merge pull request #1100 from Inxton/chore/docs-after-dev

ci: run docs build+deploy inside dev workflow

Author: PTKu

.github/workflows/dev.yml

@@ -1,6 +1,12 @@
 name: dev
 permissions:
   contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 on:
 #  push:
@@ -53,3 +59,35 @@ jobs:
         dotnet run --project cake/Build.csproj --do-publish-only --do-publish --do-publish-release
         "PACK_EXIT_CODE=$LASTEXITCODE" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
       shell: pwsh
+
+  docs:
+    needs: build
+    runs-on: [self-hosted, Windows, X64, L2, AX]
+    steps:
+    - name: Generate ctrl API metadata (ixd)
+      shell: pwsh
+      run: .\scripts\_invoke_ixd.ps1
+
+    - name: Docfx metadata
+      shell: pwsh
+      run: dotnet docfx metadata .\docfx\docfx.json
+
+    - name: Docfx build
+      shell: pwsh
+      run: dotnet docfx build .\docfx\docfx.json --output .\docs\
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs
+
+  deploy:
+    needs: docs
+    runs-on: [self-hosted, Windows, X64, L2, AX]
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/docs.yml

@@ -1,13 +1,6 @@
 name: docs
 
 on:
-  push:
-    branches: [ "dev" ]
-    paths:
-      - 'src/**'
-      - 'docfx/**'
-      - 'scripts/_build_documentation.ps1'
-      - '.github/workflows/docs.yml'
   workflow_dispatch:
 
 permissions:
@@ -30,39 +23,7 @@ jobs:
 
       - name: Generate ctrl API metadata (ixd)
         shell: pwsh
-        run: |
-          dotnet ixd `
-            -x .\src\abstractions\ctrl `
-               .\src\core\ctrl `
-               .\src\data\ctrl `
-               .\src\inspectors\ctrl `
-               .\src\io\ctrl `
-               .\src\probers\ctrl `
-               .\src\simatic1500\ctrl `
-               .\src\timers\ctrl `
-               .\src\utils\ctrl `
-               .\src\components.abstractions\ctrl `
-               .\src\components.abb.robotics\ctrl `
-               .\src\components.balluff.identification\ctrl `
-               .\src\components.cognex.vision\ctrl `
-               .\src\components.desoutter.tightening\ctrl `
-               .\src\components.drives\ctrl `
-               .\src\components.dukane.welders\ctrl `
-               .\src\components.elements\ctrl `
-               .\src\components.festo.drives\ctrl `
-               .\src\components.keyence.vision\ctrl `
-               .\src\components.kuka.robotics\ctrl `
-               .\src\components.mitsubishi.robotics\ctrl `
-               .\src\components.pneumatics\ctrl `
-               .\src\components.rexroth.drives\ctrl `
-               .\src\components.rexroth.press\ctrl `
-               .\src\components.rexroth.tightening\ctrl `
-               .\src\components.robotics\ctrl `
-               .\src\components.siem.communication\ctrl `
-               .\src\components.siem.identification\ctrl `
-               .\src\components.ur.robotics\ctrl `
-               .\src\components.zebra.vision\ctrl `
-            -o .\docfx\apictrl\
+        run: .\scripts\_invoke_ixd.ps1
 
       - name: Docfx metadata
         shell: pwsh

scripts/_build_documentation.ps1

@@ -1,35 +1,4 @@
-dotnet ixd `
--x .\src\abstractions\ctrl `
-.\src\core\ctrl `
-.\src\data\ctrl `
-.\src\inspectors\ctrl `
-.\src\io\ctrl `
-.\src\probers\ctrl `
-.\src\simatic1500\ctrl `
-.\src\timers\ctrl `
-.\src\utils\ctrl `
-.\src\components.abstractions\ctrl `
-.\src\components.abb.robotics\ctrl `
-.\src\components.balluff.identification\ctrl `
-.\src\components.cognex.vision\ctrl `
-.\src\components.desoutter.tightening\ctrl `
-.\src\components.drives\ctrl `
-.\src\components.dukane.welders\ctrl `
-.\src\components.elements\ctrl `
-.\src\components.festo.drives\ctrl `
-.\src\components.keyence.vision\ctrl `
-.\src\components.kuka.robotics\ctrl `
-.\src\components.mitsubishi.robotics\ctrl `
-.\src\components.pneumatics\ctrl `
-.\src\components.rexroth.drives\ctrl `
-.\src\components.rexroth.press\ctrl `
-.\src\components.rexroth.tightening\ctrl `
-.\src\components.robotics\ctrl `
-.\src\components.siem.communication\ctrl `
-.\src\components.siem.identification\ctrl `
-.\src\components.ur.robotics\ctrl `
-.\src\components.zebra.vision\ctrl `
--o .\docfx\apictrl\
+& "$PSScriptRoot\_invoke_ixd.ps1"
 
 # Generate metadata (.NET API documentation) from C# projects
 dotnet docfx metadata .\docfx\docfx.json

scripts/_invoke_ixd.ps1

@@ -0,0 +1,36 @@
+param(
+    [string]$Output = ".\docfx\apictrl\"
+)
+
+dotnet ixd `
+    -x .\src\abstractions\ctrl `
+       .\src\core\ctrl `
+       .\src\data\ctrl `
+       .\src\inspectors\ctrl `
+       .\src\io\ctrl `
+       .\src\probers\ctrl `
+       .\src\simatic1500\ctrl `
+       .\src\timers\ctrl `
+       .\src\utils\ctrl `
+       .\src\components.abstractions\ctrl `
+       .\src\components.abb.robotics\ctrl `
+       .\src\components.balluff.identification\ctrl `
+       .\src\components.cognex.vision\ctrl `
+       .\src\components.desoutter.tightening\ctrl `
+       .\src\components.drives\ctrl `
+       .\src\components.dukane.welders\ctrl `
+       .\src\components.elements\ctrl `
+       .\src\components.festo.drives\ctrl `
+       .\src\components.keyence.vision\ctrl `
+       .\src\components.kuka.robotics\ctrl `
+       .\src\components.mitsubishi.robotics\ctrl `
+       .\src\components.pneumatics\ctrl `
+       .\src\components.rexroth.drives\ctrl `
+       .\src\components.rexroth.press\ctrl `
+       .\src\components.rexroth.tightening\ctrl `
+       .\src\components.robotics\ctrl `
+       .\src\components.siem.communication\ctrl `
+       .\src\components.siem.identification\ctrl `
+       .\src\components.ur.robotics\ctrl `
+       .\src\components.zebra.vision\ctrl `
+    -o $Output

scripts/build_test_docu.ps1

@@ -1,35 +1,4 @@
-dotnet ixd `
--x .\src\abstractions\ctrl `
-.\src\core\ctrl `
-.\src\data\ctrl `
-.\src\inspectors\ctrl `
-.\src\io\ctrl `
-.\src\probers\ctrl `
-.\src\simatic1500\ctrl `
-.\src\timers\ctrl `
-.\src\utils\ctrl `
-.\src\components.abstractions\ctrl `
-.\src\components.abb.robotics\ctrl `
-.\src\components.balluff.identification\ctrl `
-.\src\components.cognex.vision\ctrl `
-.\src\components.desoutter.tightening\ctrl `
-.\src\components.drives\ctrl `
-.\src\components.dukane.welders\ctrl `
-.\src\components.elements\ctrl `
-.\src\components.festo.drives\ctrl `
-.\src\components.keyence.vision\ctrl `
-.\src\components.kuka.robotics\ctrl `
-.\src\components.mitsubishi.robotics\ctrl `
-.\src\components.pneumatics\ctrl `
-.\src\components.rexroth.drives\ctrl `
-.\src\components.rexroth.press\ctrl `
-.\src\components.rexroth.tightening\ctrl `
-.\src\components.robotics\ctrl `
-.\src\components.siem.communication\ctrl `
-.\src\components.siem.identification\ctrl `
-.\src\components.ur.robotics\ctrl `
-.\src\components.zebra.vision\ctrl `
--o .\docfx\apictrl\
+& "$PSScriptRoot\_invoke_ixd.ps1"
 
 if ((Test-Path .\docs-test\)) {
     del .\docs-test\