Create Doxygen documentation on PR as artifact #134
Workflow file for this run
This file contains 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
| # SPDX-FileCopyrightText: 2021 Philipp Basler, Margarete Mühlleitner and Jonas Müller | |
| # | |
| # SPDX-License-Identifier: GPL-3.0-or-later | |
| name: Doxygen Deploy | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| CreateDocumentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - name: installPackages | |
| run: sudo apt-get install --no-install-recommends --yes doxygen | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax | |
| architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified | |
| - name: Install conan | |
| run: pip install conan>2 | |
| - name: Get number of CPU cores | |
| uses: SimenB/github-actions-cpu-cores@v2 | |
| id: cpu-cores | |
| - run: python3 Setup.py --build-missing | |
| - run: cmake --preset conan-linux-x86_64-release | |
| - run: cmake --build --preset conan-linux-x86_64-release -j${{ steps.cpu-cores.outputs.count }} -t doc | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| path: build/linux-x86_64-release/html | |
| name: documentation | |
| UploadDocumentation: | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/master' | |
| needs: CreateDocumentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: documentation | |
| path: documentation | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4.6.3 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: documentation # The folder the action should deploy. | |
| target-folder: documentation |