unified-memory-framework/.github/workflows/reusable_docs_build.yml at main · oneapi-src/unified-memory-framework · 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
79
80
81
82
83
name: Docs build

on:
  workflow_call:
    inputs:
      upload:
        description: Should HTML documentation be uploaded as artifact?
        type: boolean
        default: false

permissions:
  contents: read

jobs:
  DocsBuild:
    name: Docs build
    runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-22.04' || 'ubuntu-latest' }}

    steps:
    - name: Checkout repository
      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      with:
        fetch-depth: 0

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

    # Latest distros do not allow global pip installation
    - name: Install Python requirements in venv
      run: |
        python3 -m venv .venv
        . .venv/bin/activate
        echo "$PATH" >> $GITHUB_PATH
        python3 -m pip install -r third_party/requirements.txt

    - name: Build the documentation
      run: |
        cmake -B build \
          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF \
          -DUMF_BUILD_CUDA_PROVIDER=OFF \
          -DUMF_BUILD_TESTS=OFF \
          -DUMF_BUILD_EXAMPLES=OFF
        cmake --build build --target docs

    #
    # Documentation is built. Now we want to add benchmark dashboard.
    # We only do it if inputs.upload is set, as this job is also used for testing docs build.
    #
    - name: Checkout benchmark scripts
      if: ${{ inputs.upload == true }}
      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      with:
        repository: intel/llvm
        # 30.07.2025
        # branch: sycl
        ref: 8f54710553800eec05a6fd9717b14f995a22b137
        path: sc
        sparse-checkout: |
          devops/scripts/benchmarks

    - name: Move benchmark HTML files
      if: ${{ inputs.upload == true }}
      working-directory: ${{ github.workspace }}/build/docs_build/generated/html
      run: |
        mkdir performance
        mv ${{ github.workspace }}/sc/devops/scripts/benchmarks/html/* performance/

    - name: Replace config.js
      if: ${{ inputs.upload == true }}
      working-directory: ${{ github.workspace }}/build/docs_build/generated/html
      run: |
        cat << 'EOF' > ./performance/config.js
        remoteDataUrl = 'https://raw.githubusercontent.com/oneapi-src/unified-memory-framework/refs/heads/benchmark-results/';
        defaultCompareNames = ["Baseline_PVC"];
        EOF

    - name: Upload artifact
      if: ${{ inputs.upload == true }}
      uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
      with:
        path: build/docs_build/generated/html