gh-pages.yml

# Copyright (c) 2025-2026, The Isaac Lab Arena Project Developers (https://github.com/isaac-sim/IsaacLab-Arena/blob/main/CONTRIBUTORS.md).
# All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

name: GitHub Pages

on:
  push:
    branches: [ "main" ]

# Concurrency control to prevent parallel runs on the same PR
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: write
  pull-requests: write
  checks: write
  issues: read

env:
  NGC_API_KEY: ${{ secrets.ARENA_NGC_API_KEY }}
  OMNI_PASS: ${{ secrets.OMNI_PASS }}
  OMNI_USER: ${{ secrets.OMNI_USER }}

jobs:
  deploy_docs:
    name: Deploy the docs
    runs-on: [self-hosted, gpu]
    timeout-minutes: 30

    container:
      image: python:3.11-slim

    steps:
      - name: Install git (and tools needed by hooks)
        run: |
          apt-get update
          apt-get install -y --no-install-recommends git git-lfs clang-format ca-certificates make
          git --version
          git lfs version

      # Checkout Code
      - name: Checkout Code
        uses: actions/checkout@v4
        with:
          clean: true
          fetch-depth: 0
          fetch-tags: true

      # Fix "detected dubious ownership in repository" inside containers
      - name: Mark repo as safe for git
        run: git config --global --add safe.directory "$PWD"

      # Build docs
      - name: Build docs
        run: |
          cd docs
          pip3 install -r requirements.txt
          make SPHINXOPTS=-W multi-docs
          touch ./_build/.nojekyll

      - name: Copy redirect file
        run: |
          cp ./docs/_redirect/index.html ./docs/_build/index.html

      # Deploy to gh-pages
      - name: Deploy to gh-pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build