website.yml

name: Publish website
on:
  push:
    branches:
      - main
  workflow_dispatch:

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

jobs:
  deploy:
    name: Publish docs website
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com

      - name: Set up Python
        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
        with:
          python-version-file: '.python-version'
          cache: 'pip' # caching pip dependencies

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

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

      - name: Deploy GitHub Pages
        run: mkdocs gh-deploy --force

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