documentation-deploy.yml

name: Documentation - Deploy to GitHub Pages
on:
  push:
    branches:
      - master
  workflow_dispatch:
    
jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout main
        uses: actions/checkout@v3
        # Only pull lfs files for documentation folder
        # https://github.com/git-lfs/git-lfs/issues/1351
      - name: Checkout git lfs partial files
        run: git lfs pull --include "documentation/*"
      - name: Remove Git LFS requirements
        # Github pages fails when expecting LFS, so remove hook
        run: rm .git/hooks/pre-push
      - name: Deploy docs
        # TODO - check if working on latest or pin to version (rather than commit)
        uses: mhausenblas/mkdocs-deploy-gh-pages@e55ecab6718b449a90ebd4313f1320f9327f1386
        # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # CUSTOM_DOMAIN: optionaldomain.com
          CONFIG_FILE: documentation/mkdocs.yml
          # EXTRA_PACKAGES: build-base
          # GITHUB_DOMAIN: github.myenterprise.com
          REQUIREMENTS: documentation/requirements.txt