build-deploy-docs.yml

name: Build and Deploy Documentation

on:
  push:
    branches: [ main ]
    tags:
      - 'v[0-9]*.[0-9]*.[0-9]*'
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  Build_and_deploy_doc:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup PDM
        uses: pdm-project/setup-pdm@v4
        with:
          python-version: '3.13'

      - name: Install dependencies (default & doc)
        run: pdm install --group doc --frozen-lockfile

      - name: Build Documentation
        working-directory: docs
        run: pdm run make dirhtml

      - name: Determine deployment folder
        id: deploy_folder
        run: |
          echo "Determining deployment folder..."
          if [ "${{ github.event_name }}" = "pull_request" ]; then
            echo "Deploying to target pr/${{ github.event.number }}"
            echo "DEPLOY_DIR=pr/${{ github.event.number }}" >> $GITHUB_OUTPUT
          elif [[ "${{ github.ref }}" == refs/tags/* ]]; then
            echo "Deploying to target ${{ github.ref_name }}"
            echo "DEPLOY_DIR=${{ github.ref_name }}" >> $GITHUB_OUTPUT
          else
            echo "Deploying to target main"
            echo "DEPLOY_DIR=main" >> $GITHUB_OUTPUT
          fi

      - name: Deploy to DEPLOY_DIR of TorchJD/documentation
        uses: peaceiris/actions-gh-pages@v4
        with:
          deploy_key: ${{ secrets.DOCUMENTATION_DEPLOY_KEY }}
          publish_dir: docs/build/dirhtml
          destination_dir: ${{ steps.deploy_folder.outputs.DEPLOY_DIR }}
          external_repository: TorchJD/documentation
          publish_branch: main

      - name: Deploy to stable of TorchJD/documentation
        if: startsWith(github.ref, 'refs/tags/')
        uses: peaceiris/actions-gh-pages@v4
        with:
          deploy_key: ${{ secrets.DOCUMENTATION_DEPLOY_KEY }}
          publish_dir: docs/build/dirhtml
          destination_dir: stable
          external_repository: TorchJD/documentation
          publish_branch: main

      - name: Add documentation link to summary
        run: |
          echo "### 📄 [View Deployed Documentation](https://torchjd.github.io/documentation/${{ steps.deploy_folder.outputs.DEPLOY_DIR }})" >> $GITHUB_STEP_SUMMARY