gh-pages-check.yml

# This is a basic workflow to help you get started with Actions

name: GH-Pages-Check

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  pull_request:
    branches: [ master ]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  doxygen:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
    - uses: actions/checkout@v2
      with:
        submodules: recursive

    # Install Doxygen
    - name: Install Doxygen
      run: sudo apt-get install -qq doxygen

    # Generate Doxygen
    - name: Generate docs
      run: doxygen

    # Error if doxygen.error has content
    - name: Check documentation has no errors
      run: |
          if [[ $(wc -l <doxygen.error) -gt 0 ]]
          then
              cat doxygen.error
              exit 1
          fi