From 4a5e6bc1c394c26426016bf4b6747dd0f72dc923 Mon Sep 17 00:00:00 2001 From: Daniel Nicoletti Date: Sun, 7 Jul 2024 18:01:53 -0300 Subject: [PATCH] Deploy doxygen docs to git hub pages --- .github/workflows/documentation.yml | 69 +++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..a6573b6d --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,69 @@ +# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: Deploy doxygen to GitHub Pages + +on: + push: + branches: + - kdreports-2.2 + +# 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 + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Install Dependencies on Linux + run: | + sudo apt update -qq + sudo apt install -y doxygen + + - name: Install Qt + 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 -DKDReports_DOCS=ON + + - name: Create docs + 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 + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4