docs.yml

name: Publish Docs

on:
  workflow_dispatch:
  pull_request:
  push:
    tags: ["v*"]

permissions:
  contents: read

jobs:
  build_docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout psi-data-utils
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version-file: .python-version
          cache: pip

      - name: Install docs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -e ".[docs]"

      - name: Build docs
        run: |
          sphinx-build docs/source docs/_build/html

      - name: Upload docs artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: docs/_build/html/
          retention-days: 7

      - name: Install SSH key
        uses: shimataro/ssh-key-action@v2
        with:
          key: ${{ secrets.DOCS_SSH_KEY }}
          known_hosts: "placeholder"

      - name: Add known_hosts from target
        env:
          SSH_HOST: ${{ secrets.DOCS_SSH_HOST }}
          SSH_PORT: ${{ secrets.DOCS_SSH_PORT }}
        run: |
          mkdir -p ~/.ssh
          ssh-keyscan -p "${SSH_PORT:-22}" -H "${SSH_HOST}" >> ~/.ssh/known_hosts

      - name: Rsync to server
        env:
          SSH_HOST: ${{ secrets.DOCS_SSH_HOST }}
          SSH_USER: ${{ secrets.DOCS_SSH_USER }}
          SSH_PORT: ${{ secrets.DOCS_SSH_PORT }}
          REMOTE_DIR: ${{ secrets.DOCS_SSH_PATH }}
        run: |
          ssh -p "${SSH_PORT:-22}" "${SSH_USER}@${SSH_HOST}" "mkdir -p '${REMOTE_DIR}'"

          rsync -rlvz \
            --delete \
            --omit-dir-times --no-times \
            --no-perms --no-owner --no-group \
            --chmod=D755,F644 \
            -e "ssh -p ${SSH_PORT:-22}" \
            docs/_build/html/ "${SSH_USER}@${SSH_HOST}:${REMOTE_DIR}/"