documentation.yaml

name: Build documentation

on:
  pull_request:
    types: [closed]
    branches:
      - master
    # Only run the workflow when the pull request is merged
    # and not when it is closed without merging
    # To achieve this we can check the pull_request.merged flag
    # and ensure it is true
    # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context
    # https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request
    # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#pull_requestmerged
    # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#booleans
    if: github.event.pull_request.merged == true

jobs:

  docs:

    runs-on: ubuntu-latest

    env:
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

    steps:

      - uses: actions/checkout@v2.3.4
        with:
          submodules: 'recursive'

      - run: |
          sudo apt install doxygen graphviz -y

      - run: |
          cd doc/
          python gen_mainpage.py
          doxygen

      - run: |
          cd doc/html
          git init
          touch .nojekyll
          git add -A
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git commit -m 'deploy'

      - uses: ad-m/github-push-action@v0.6.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          force: true
          directory: ./doc/html