build_pr_documentation.yml

name: Build PR Documentation

on:
  pull_request:
    branches:
      - main

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

jobs:
  build_documentation:
    runs-on: ubuntu-22.04
    env:
      COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
      PR_NUMBER: ${{ github.event.number }}
      EVENT_CONTEXT: ${{ toJSON(github.event) }}
      PR_CLONE_URL: ${{ github.event.pull_request.head.repo.clone_url }}

    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '18'
          cache-dependency-path: "kit/package-lock.json"

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      - name: Setup environment
        run: |
          pip install --upgrade pip
          pip install git+https://github.com/huggingface/doc-builder
          pip install .[quality]

      - name: Make documentation
        shell: bash
        run: |
          doc-builder build optimum.executorch docs/source/ \
            --repo_name optimum-executorch \
            --build_dir executorch-doc-build/ \
            --version pr_${{ env.PR_NUMBER }} \
            --version_tag_suffix "" \
            --html \
            --clean \

      - name: Save commit_sha & pr_number
        run: |
          sudo chmod -R ugo+rwx executorch-doc-build
          cd executorch-doc-build
          sudo mv optimum.executorch optimum-executorch
          echo ${{ env.COMMIT_SHA }} > ./commit_sha
          echo ${{ env.PR_NUMBER }} > ./pr_number

      - uses: actions/upload-artifact@v6
        with:
          name: doc-build-artifact
          path: executorch-doc-build/