Publish docs as GitHub pages #3
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: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]> | |
| # | |
| # SPDX-License-Identifier: LGPL-2.1-only OR LicenseRef-KDAB-KDStateMachineEditor | |
| name: Deploy doxygen to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install Dependencies on Linux | |
| if: ${{ runner.os == 'Linux' }} | |
| run: | | |
| sudo apt update -qq | |
| sudo apt install -y doxygen | |
| - name: Install Qt | |
| if: ${{ runner.os != 'Windows' }} | |
| uses: jurplel/install-qt-action@v3 | |
| with: | |
| aqtversion: null # use whatever the default is | |
| version: 5.15.2 | |
| cache: true | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Configure project | |
| run: > | |
| cmake -S . -B ./build | |
| -DBUILD_QT6=OFF | |
| -DBUILD_TESTS=OFF | |
| -DBUILD_EXAMPLES=OFF | |
| -DBUILD_DOCS=ON | |
| - name: Build Project | |
| run: cmake --build ./build --target docs | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: build/docs/api/html/ | |
| # Deployment job, what was uploaded to artifact | |
| deploy: | |
| needs: build | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |