diff options
| author | Leitwolf11 | 2026-10-15 18:35:17 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-15 18:35:17 +0300 |
| commit | 018696d64cdb4088c0dd502ceab8d8ed9e11543e (patch) | |
| tree | 402412587d273cd488b941878f902d313b47fa41 /.github/workflows | |
| parent | a460c4c7e922f37705b2be3f1fa7c789f514cd51 (diff) | |
| download | website-018696d64cdb4088c0dd502ceab8d8ed9e11543e.tar.gz | |
Gate the API documentation with DocFX
The Kotlin backend checked its documentation with Dokka; the ASP.NET Core
API had only the compiler warning for a public declaration without a
comment. CI now builds the API reference with DocFX, every warning as an
error, and Documents/api/CheckDocumentation.cs fails when a namespace,
type or member of the reference has no description, internal and
private members included. The setup is the one Progmaweb uses: the
docfx tool pinned in .config/dotnet-tools.json, the configuration and
the namespace description under Documents/api, and the generated
reference ignored.
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/ci.yml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4929d81..6aee49a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -65,6 +65,12 @@ jobs: - run: dotnet build Progmasoft.Tala.Website.slnx --configuration Release --no-restore - run: dotnet test --project backend/Progmasoft.Tala.Website.Api.Tests/Progmasoft.Tala.Website.Api.Tests.csproj --configuration Release --no-build --coverlet --coverlet-output-format cobertura --results-directory TestResults - run: dotnet publish backend/Progmasoft.Tala.Website.Api/Progmasoft.Tala.Website.Api.csproj --configuration Release --no-restore --output publish + # Documentation gate. DocFX builds the API reference with every warning + # as an error; the coverage check then fails when a namespace, type or + # member of the reference has no description. + - run: dotnet tool restore + - run: dotnet docfx Documents/api/docfx.json --warningsAsErrors + - run: dotnet run Documents/api/CheckDocumentation.cs -- Documents/api - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: website-backend-coverage |