format the source code after large feature update #31
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
name: Publish Docs | |
on: | |
push: | |
tags: | |
- '**' | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- | |
name: checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
submodules: 'recursive' # for doxygen-awesome-css | |
- | |
name: install doxygen 1.9.2 | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y doxygen graphviz | |
- | |
name: set version | |
run: | | |
_version_tag=$(git describe --tags) | |
_cmake_version=v$(grep "^[ \t]*VERSION" CMakeLists.txt | sed 's/[^.0-9]*//g') | |
if [[ "${_version_tag}" != "${_cmake_version}" ]]; then | |
echo "::error::Git version ${_version_tag} does not match CMake version ${_cmake_version}" | |
exit 1 | |
fi | |
echo ${_version_tag} | |
echo "PROJECT_NUMBER = ${_version_tag}" >> docs/doxyfile | |
- | |
name: run doxygen | |
run: doxygen docs/doxyfile | |
- | |
name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v5 | |
- | |
name: Upload Artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ./docs/html | |
deploy: | |
if: startsWith(github.ref, 'refs/tags/v') | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |