Interfaces/.github/workflows/cpp-docs.yml at main · linksplatform/Interfaces · 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
name: C++ documentation

on:
  push:
    branches: [main]
    paths:
      - 'cpp/Platform.Interfaces/**'
      - 'cpp/Doxyfile'
      - '.github/scripts/check-cpp-docs.py'
      - '.github/scripts/check-cpp-docs.test.py'
      - '.github/workflows/cpp-docs.yml'
  pull_request:
    branches: [main]
    paths:
      - 'cpp/Platform.Interfaces/**'
      - 'cpp/Doxyfile'
      - '.github/scripts/check-cpp-docs.py'
      - '.github/scripts/check-cpp-docs.test.py'
      - '.github/workflows/cpp-docs.yml'

jobs:
  build:
    runs-on: ubuntu-24.04
    timeout-minutes: 10
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - name: Install Doxygen
        run: |
          sudo apt-get update
          sudo apt-get install -y doxygen
      - name: Check documentation coverage
        run: |
          python3 .github/scripts/check-cpp-docs.test.py
          python3 .github/scripts/check-cpp-docs.py
      - name: Generate documentation
        run: |
          doxygen cpp/Doxyfile
          test -s cpp/docs/html/index.html
          test -s cpp/docs/xml/index.xml
      - name: Upload HTML and XML documentation
        uses: actions/upload-artifact@v4
        with:
          name: cpp-api-documentation
          path: |
            cpp/docs/html
            cpp/docs/xml