nfx-datetime/.github/workflows/documentation.yml at main · nfx-libs/nfx-datetime · 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: Generate Documentation
on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - "include/**"
      - "doc/**"
      - "README.md"
      - "CHANGELOG.md"
      - ".github/workflows/documentation.yml"
      - "**/CMakeLists.txt"
      - "**/*.cmake"
      - "**/*.cmake.in"

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: github-pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: Cache Doxygen
        id: cache-doxygen
        uses: actions/cache@v4
        with:
          path: ~/doxygen-1.15.0
          key: doxygen-1.15.0-linux

      - name: Install Dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y graphviz

          if [ ! -f ~/doxygen-1.15.0/bin/doxygen ]; then
            wget https://www.doxygen.nl/files/doxygen-1.15.0.linux.bin.tar.gz
            tar -xzf doxygen-1.15.0.linux.bin.tar.gz -C ~/
          fi

          sudo cp ~/doxygen-1.15.0/bin/doxygen /usr/local/bin/
          doxygen --version

      - name: Configure CMake
        run: |
          cmake -B build -DNFX_DATETIME_BUILD_DOCUMENTATION=ON

      - name: Build Documentation
        run: cmake --build build --target nfx-datetime-documentation

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ./build/doc/html

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4