gh-pages.yml

name: Build and deploy to gh-pages
on:
   push:
     branches:
       - master
   workflow_dispatch: # Allow to run workflow manually

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 📥
        uses: actions/checkout@v4.2.2
        with:
          token: '${{ secrets.GHPAGES_ACTION_CHECKOUT_TOKEN_PAT }}'
          fetch-depth: '0' # https://github.com/timvink/mkdocs-git-revision-date-localized-plugin#note-when-using-build-environments

      - name: Install dependencies 🐄
        run: |
          sudo apt-get -y update
          sudo apt-get -y install python3-pip
          python -m venv venv
          source ./venv/bin/activate
          pip install -r requirements.txt

      - name: Build site 🔧
        run: |
          source ./venv/bin/activate
          mkdocs build --verbose --clean

      - name: Fixing redirects 🚧
        run: |
          bash .github/workflows/fix_redirects.sh

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4.6.8
        with:
          token: '${{ secrets.GHPAGES_ACTION_DEPLOY_TOKEN_PAT }}'
          git-config-name: '${{ secrets.GHPAGES_ACTION_DEPLOY_GITNAME_PAT }}'
          git-config-email: '${{ secrets.GHPAGES_ACTION_DEPLOY_GITEMAIL_PAT }}'
          branch: gh-pages # The branch the action should deploy to.
          folder: site # The folder the action should deploy.