diff options
| author | Leitwolf | 2026-10-03 18:46:55 +0300 |
|---|---|---|
| committer | GitHub | 2026-10-03 18:46:55 +0300 |
| commit | cf444eb3bccf99c10f59ed5330b61c0397e0aeaa (patch) | |
| tree | 5012d38d7dfc1bdc4cf75c3db7772d3fac7a5a4e /.github/workflows | |
| parent | bc1b0b080b398e52b3201034f92398750f415ed2 (diff) | |
| parent | 08a076a3f880764462410a0b2f855d5bdfba1066 (diff) | |
| download | progmaweb-cf444eb3bccf99c10f59ed5330b61c0397e0aeaa.tar.gz | |
Merge pull request #26 from Progmasoft/ci/docfx-require-documentation
Require documentation for every item of the API reference
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/backend.yml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml index a1f6320..6504906 100644 --- a/.github/workflows/backend.yml +++ b/.github/workflows/backend.yml @@ -47,10 +47,13 @@ jobs: - run: dotnet build Progmaweb.slnx --configuration Release --no-restore - run: dotnet test --project apps/api-tests/Progmaweb.Api.Tests.csproj --configuration Release --no-build --coverlet --coverlet-output-format cobertura - # Documentation gate: DocFX reads the API project and builds the - # reference; an unresolved reference or a broken link is an error. + # Documentation gate. DocFX reads the API project and builds the + # reference; an unresolved reference or a broken link is an error. The + # coverage check then fails when a namespace, type or member of the + # reference has no description, which DocFX itself does not report. - run: dotnet tool restore - run: dotnet docfx docs/api/docfx.json --warningsAsErrors + - run: dotnet run docs/api/CheckDocumentation.cs -- docs/api - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: |