name: Doxygen

on:
  push:
    branches:
    - 'master'

permissions:
  contents: read
  pages: write    # Required to push to the Pages server
  id-token: write # Required to verify the deployment is legitimate

jobs:
  doxygen:
    if: "!(contains(github.event.head_commit.message, '[doxy skip]') || contains(github.event.head_commit.message, '[skip doxy]'))"
    runs-on: 'ubuntu-latest'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
    - name: Checkout repository
      uses: actions/checkout@v6

    - name: Install dependencies
      run: ./.github/scripts/install-dependencies-ubuntu.sh

    - name: Generate Doxygen documentation
      run: ./.github/scripts/build-doxygen.sh

    - name: Dump generated files
      run: find ./build -type f -print

    - name: Upload built pages
      uses: actions/upload-pages-artifact@v4
      with:
        path: './build/docs/html'

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