fluidsynth/.github/workflows/api_doc_build.yml at master · FluidSynth/fluidsynth · 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
84
85
86
87
name: API Doc & Wiki Build

on:
  push:
    paths-ignore:
      - '.azure/**'
      - '.circleci/**'
      - '.github/workflows/rendering-regression.yml'
      - '.github/workflows/linux.yml'
      - '.github/workflows/ios.yml'
      - '.github/workflows/sonarcloud.yml'
      - '.github/workflows/windows.yml'
      - '.cirrus.yml'
      - 'README.md'
  workflow_dispatch:

env:
  BUILD_TYPE: Release
  DOXYGEN_VERSION: "1.17.0"

concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-22.04

    steps:
    - uses: actions/checkout@v6
      with:
        persist-credentials: false

    - name: Update Dependencies
      run: sudo apt-get update

    - name: Install Dependencies
      run: sudo apt-get install xsltproc libxslt1-dev

    - name: Install Doxygen ${{ env.DOXYGEN_VERSION }}
      run: |
        DOXYGEN_VERSION_UNDERSCORED="${DOXYGEN_VERSION//./_}"
        curl --proto-redir =https -fsSL "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION_UNDERSCORED}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz" \
          | sudo tar -xz --strip-components=1 -C /usr/local
        doxygen --version

    - name: Create Build Environment
      run: cmake -E make_directory ${{runner.workspace}}/build

    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: "3.13"

    - name: Install Python dependencies
      run: 'pip install --only-binary :all: --require-hashes -r doc/zensical/requirements.lock'

    - name: Configure CMake
      shell: bash
      working-directory: ${{runner.workspace}}/build
      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE

    - name: Build unified wiki and API documentation site
      shell: bash
      working-directory: ${{runner.workspace}}/build
      run: cmake --build . --config $BUILD_TYPE --target zensical

    - name: Upload documentation site as artifact
      uses: actions/upload-artifact@v4
      with:
        name: fluidsynth-docs-${{ github.sha }}
        path: .zensical/wiki/
        retention-days: 7

    - name: Publish to GH Pages
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        folder: .zensical/wiki/
        repository-name: FluidSynth/fluidsynth.github.io
        branch: main
        ssh-key: ${{ secrets.DEPLOY_API_TOKEN }}
        target-folder: wiki/
        clean: true
        commit-message: Updating wiki and API docs from fluidsynth master
        git-config-name: Zensical Deploy
        git-config-email: fluid-wiki-deploy@fluidsynth.github.io