Skip to content

Commit

Permalink
Deploy doxygen docs to github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dantti committed Jul 8, 2024
1 parent cb731ae commit 02d314f
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
#
# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

name: Deploy doxygen to GitHub Pages

on:
push:
branches:
- main
pull_request:
branches:
- main

# 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 graphviz
- name: Checkout sources
uses: actions/checkout@v4
with:
submodules: recursive

- name: Configure project
run: cmake -S . -B ./build -DKDSPDSETUP_BUILD_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

0 comments on commit 02d314f

Please sign in to comment.