build_and_deploy.yml

name: Build and Deploy
run-name: "🚀[${{ github.workflow }}] - ${{ github.event.head_commit.message }}"

on:
  push:
    branches:
      - main

concurrency:
  group: ${{ github.workflow}}
  cancel-in-progress: true

env:
  PYTHON_VERSION: 3.x

permissions:
  contents: write
  id-token: write
  pages: write

jobs:
  build_and_deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          sparse-checkout: |
            docs
            tools

      - name: Set up Python runtime
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
          cache: pip
          cache-dependency-path: |
            requirements.txt

      - name: Debug
        run: |
          env | sort -f
          ls -lart

      - name: Get pip cache dir
        run: |
          os_version=$(cat /etc/os-release | grep -i "version=" | cut -c9- | tr -d '"' | tr ' ' '_')
          github_workflow_full_path="${GITHUB_WORKFLOW_REF%@*}"
          python_full_version=$(python -c 'import platform; print(platform.python_version())')
          node_major_version=$(node --version | cut -d'.' -f1 | tr -d 'v')
          echo "os_version=$os_version" >> $GITHUB_ENV
          echo "github_workflow_full_path=$github_workflow_full_path" >> $GITHUB_ENV
          echo "python_full_version=$python_full_version" >> $GITHUB_ENV
          echo "PIP_CACHE_DIR=$(pip cache dir)" >> $GITHUB_ENV

      - name: cache pip
        uses: actions/cache@v3
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ env.github_workflow_full_path}}-${{ env.os_version }}-${{ env.python_full_version }}-${{ env.node_major_version}}-${{ hashFiles('requirements.txt') }}

      # - name: Set up build cache
      #   uses: actions/cache/restore@v3
      #   with:
      #     key: mkdocs-material-${{ hashfiles('.cache/**') }}
      #     path: .cache
      #     restore-keys: |
      #       mkdocs-material-

      - name: Install dependencies
        run: sudo apt-get install pngquant

      - name: Install Python dependencies
        run: |
          pip install -U pip
          pip install -U -r requirements.txt

      - name: Build documentation
        run: |
          mkdocs --version
          # https://github.com/facelessuser/pymdown-extensions/issues/2240#issuecomment-1819117598
          python -m mkdocs build -s

      # - name: Adjust permissions
      #   run: |
      #     chmod -c -R +rX site/ | while read line; do
      #       echo "::warning title=Invalid file permissions automatically fixed::$line"
      #     done

      - name: Upload to GitHub Pages
        uses: actions/upload-pages-artifact@v2
        with:
          path: site

      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@v2

      # - name: Save build cache
      #   uses: actions/cache/save@v3
      #   with:
      #     key: mkdocs-material-${{ hashfiles('.cache/**') }}
      #     path: .cache