1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
|
name: Build and Deploy Docs
# Trigger only if we have labeled the PR, a Release has been published or a manual trigger
on:
workflow_dispatch:
pull_request:
types: [labeled]
release:
types: [published]
permissions:
contents: write
id-token: write
pages: write
jobs:
build_docs:
if: (contains(github.event.pull_request.labels.*.name, 'documentation') ||
(contains(github.event_name, 'workflow_dispatch')) ||
(contains(github.event_name, 'release')) )
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Get doxygen and graphviz
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- name: Build docs
run: doxygen
- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@v3
with:
path: docs/html
# Only run deploy if we are on master branch
deploy:
if: github.ref == 'refs/heads/master'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build_docs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
|