Update reverb overview #544
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |