File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Workflow: Deploy DocFX to GitHub Pages
2+
3+ Builds the scripting API reference with [ DocFX] ( https://dotnet.github.io/docfx/ ) and deploys it to GitHub Pages.
4+
5+ ## Trigger
6+
7+ | Event | Condition |
8+ | :--| :--|
9+ | ` release: published ` | Runs automatically on every published release |
10+ | ` workflow_dispatch ` | Manual trigger via GitHub Actions UI |
11+
12+ ## Steps
13+
14+ | Step | Description |
15+ | :--| :--|
16+ | Checkout | Checks out the repository |
17+ | Setup .NET | Installs .NET 10 SDK |
18+ | Configure GitHub Packages | Adds the Payroll-Engine NuGet feed using ` PAT_DISPATCH ` |
19+ | Build | ` dotnet build Client.Scripting/PayrollEngine.Client.Scripting.csproj -c Release ` |
20+ | Install DocFX | Installs the latest DocFX global tool |
21+ | Build DocFX | Runs ` docfx docfx/docfx.json ` — generates HTML into ` docfx/_site/ ` |
22+ | Upload Pages artifact | Uploads ` docfx/_site/ ` as the GitHub Pages artifact |
23+ | Deploy to GitHub Pages | Deploys the artifact to the ` github-pages ` environment |
24+
25+ ## Output
26+
27+ 👉 https://payroll-engine.github.io/PayrollEngine.Client.Scripting/
28+
29+ ## Permissions
30+
31+ | Permission | Reason |
32+ | :--| :--|
33+ | ` contents: read ` | Checkout |
34+ | ` pages: write ` | Deploy to GitHub Pages |
35+ | ` id-token: write ` | OIDC token for Pages deployment |
36+
37+ ## Secrets
38+
39+ | Secret | Usage |
40+ | :--| :--|
41+ | ` PAT_DISPATCH ` | Read access to the Payroll-Engine GitHub Packages NuGet feed |
42+
43+ ## Configuration
44+
45+ DocFX is configured in ` docfx/docfx.json ` . The metadata source is the compiled assembly:
46+
47+ ```
48+ Client.Scripting/bin/Release/net10.0/PayrollEngine.*.dll
49+ ```
You can’t perform that action at this time.
0 commit comments