FastMoq/.github/workflows/validate_api_docs.yml at fbc7828b191d3a0fb57a992c667446ce9e9dff2d · cwinland/FastMoq · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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