Skip to content

Add generator runtime planning, bootstrap groundwork, settings documentation, scenario scaffold hooks, and xUnit smoke tests #100

Add generator runtime planning, bootstrap groundwork, settings documentation, scenario scaffold hooks, and xUnit smoke tests

Add generator runtime planning, bootstrap groundwork, settings documentation, scenario scaffold hooks, and xUnit smoke tests #100

name: Validate API Docs
on:
pull_request:
branches:
- master
paths:
- '.config/dotnet-tools.json'
- '.github/workflows/publish_pages.yml'
- '.github/workflows/validate_api_docs.yml'
- 'docfx-template/**'
- 'docfx.json'
- 'index.md'
- 'FAQs.md'
- 'docs/README.md'
- 'docs/api/**'
- 'docs/breaking-changes/**'
- 'docs/cookbook/**'
- 'docs/feature-parity/**'
- 'docs/getting-started/**'
- 'docs/migration/**'
- 'docs/roadmap/**'
- 'docs/samples/**'
- 'docs/whats-new/**'
- 'FastMoq.TestingExample/**'
- 'scripts/Generate-ApiDocs.ps1'
- 'scripts/Write-DocfxBuildMetadata.ps1'
- 'FastMoq.Abstractions/**'
- 'FastMoq.Core/**'
- 'FastMoq.Database/**'
- 'FastMoq.Provider.Moq/**'
- 'FastMoq.Provider.NSubstitute/**'
- 'FastMoq.Web/**'
- 'FastMoq/**'
workflow_dispatch:
concurrency:
group: api-docs-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
validate-docfx:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup .NET SDK
uses: actions/setup-dotnet@v5
with:
dotnet-version: |
8.0.x
9.0.x
10.0.x
- name: Generate API documentation
run: |
pwsh ./scripts/Generate-ApiDocs.ps1
- name: Validate generated site output
run: |
set -euo pipefail
if [ ! -f Help/index.html ]; then
echo "DocFX build did not produce Help/index.html" >&2
ls -al Help || true
exit 1
fi
- name: Upload generated docs artifact
if: always()
uses: actions/upload-artifact@v7
with:
name: api-docs-site
path: Help
if-no-files-found: error