Skip to content

reverting some extra changes #34

reverting some extra changes

reverting some extra changes #34

Workflow file for this run

name: API documentation
on:
push:
paths:
- .github/workflows/docs.yaml
- deps/**
- cmake/**
- src/**
- test/**
- docs/**
# 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:
apidoc:
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
submodules: recursive
- name: Set up OS
run: >
sudo apt-get update && sudo apt-get install -y
cmake ninja-build
ruby build-essential autoconf libtool
civetweb libcivetweb-dev libssl-dev libcjson-dev
doxygen graphviz plantuml
- name: Prep
run: ./prep.sh -DBUILD_AGENT=OFF -DBUILD_MANAGER=OFF -DBUILD_DOCS=ON
- name: Build
run: ./build.sh docs
- name: Compress
run: cd build/default/docs/doxygen && tar -cf html.tar html
- name: Archive
uses: actions/upload-artifact@v3
with:
name: doxygen
path: build/default/docs/doxygen/html.tar
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: apidoc
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- uses: actions/download-artifact@v3
with:
name: doxygen
path: build/default/docs/doxygen/
- name: Decompress
run: cd build/default/docs/doxygen && tar -xf html.tar
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Just the HTML
path: build/default/docs/doxygen/html/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2