highfive/.github/workflows/gh-pages.yml at 4133843c90020a9471bf6a9ce1641895ee57fba2 · highfive-devs/highfive · 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
name: Documentation

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

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - v2.x
      - main

# Allow only one concurrent deployment
concurrency:
  group: ${{ github.workflow }}#${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build Documentation
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          submodules: 'recursive'
          fetch-depth: 0

      - name: Install dependencies
        run: |
          pkgs=(
            doxygen
            graphviz
            libhdf5-dev
            libboost-all-dev
            libeigen3-dev
            libxtensor-dev
          )

          sudo apt-get update
          sudo apt-get install -y ${pkgs[@]}

      - name: Build documentation with CMake
        run: |
          CMAKE_OPTIONS=(
            -DHIGHFIVE_UNIT_TESTS=OFF
          )
          cmake -B build -S . "${CMAKE_OPTIONS[@]}"
          cmake --build build --target doc

      - name: Upload artifact
        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
        uses: actions/upload-pages-artifact@v4
        with:
          path: build/doc/html

  deploy:
    name: Deploy to GitHub Pages
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build

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