deploy_doxygen.yml

name: Generate API Docs

on:
  # Runs workflow 'automatically' when a pushed
  # to the development branch.
  push:
    branches: ["development"]
    # Don't apply gitignore rules, this allows us to push the generated docs.
    paths-ignore:
      - ".gitignore"

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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:
  run-doxygen:
    # Only run this step if the action was triggered automatically and the pull request merged on the development branch.
    # Or, it was triggered manually on the development branch.
    if: ${{ github.event_name == 'push' || ( github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/development' ) }}

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Run Doxygen
        uses: mattnotmitt/doxygen-action@1.9.8
        with:
          # Path to Doxyfile
          doxyfile-path: ./Doxyfile
          # Generate latex documentation
          enable-latex: false
          # Extra alpine packages for the build environment
          additional-packages: graphviz

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "docs/Doxygen"

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4