documentation.yml

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

name: Documentation

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  push:
    branches: [ master ]
  #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 "document"
  document:
    # 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@v4
    
    - name: Make sure initial ownership is correct
      run: sudo chown -R runner:docker docs/

    # Runs a single command using the runners shell
    - uses: mattnotmitt/doxygen-action@v1
      with:
          working-directory: '.'
          doxyfile-path: './Doxyfile'       
    
    - name: Make sure ownership of generated items is correct
      run: sudo chown -R runner:docker docs/
          
    - name: Switch to gh-pages
      uses: actions/checkout@v4
      with:
        ref: gh-pages
        clean: false

    - name: Move generated files where git can see them
      run: cp -rp docs/html/* .
        
    - name: Prevent generated docs dir from being committed and overwriting on the next run.
      run: rm -Rf docs/html

    - name: Update branch information
      run: git fetch --all; git branch --list -r;
      
    - name: Grab the latest markdown files
      run: git checkout origin/master -- `git ls-tree origin/master -r --name-only | grep ".md"`;
           git add -f .;

    - name: Commit files
      run: echo ${{ github.ref }};
        git config --local user.name "GitHub Action";
        git commit -m "Commiting Documentation" -a | exit 0;
        
    - name: Push to gh-pages
      run: git push;