ci: workflows: doc: use self-hosted runner

.github/workflows/doc-build.yml

@@ -17,7 +17,7 @@ permissions:
 env:
   DOXYGEN_VERSION: 1.14.0
   DOXYGEN_MD5SUM: e761a5097ae20ecccfd02041925f102a
-  JOB_COUNT: 4
+  JOB_COUNT: 8
 
 jobs:
   doc-file-check:
@@ -56,71 +56,76 @@ jobs:
     needs: [doc-file-check]
     if: >
       needs.doc-file-check.outputs.file_check == 'true' || github.event_name != 'pull_request'
-    runs-on: ubuntu-24.04
-    timeout-minutes: 90
+    runs-on:
+      group: zephyr-runner-v2-linux-x64-4xlarge
+    container:
+      image: ghcr.io/zephyrproject-rtos/ci-repo-cache:v0.28.5.20250930
+      options: '--entrypoint /bin/bash'
+    timeout-minutes: 20
     concurrency:
       group: doc-build-html-${{ github.ref }}
       cancel-in-progress: true
+    env:
+      BASE_REF: ${{ github.base_ref }}
+
 
     steps:
-    - name: install-pkgs
+
+    - name: Print cloud service information
       run: |
-        sudo apt-get update
-        sudo apt-get install -y wget python3-pip git ninja-build graphviz lcov
-        wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
-        echo "${DOXYGEN_MD5SUM}  doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz" | md5sum -c
-        if [ $? -ne 0 ]; then
-          echo "Failed to verify doxygen tarball"
-          exit 1
-        fi
-        sudo tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz -C /opt
-        echo "/opt/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
-        echo "${HOME}/.local/bin" >> $GITHUB_PATH
+        echo "ZEPHYR_RUNNER_CLOUD_PROVIDER = ${ZEPHYR_RUNNER_CLOUD_PROVIDER}"
+        echo "ZEPHYR_RUNNER_CLOUD_NODE = ${ZEPHYR_RUNNER_CLOUD_NODE}"
+        echo "ZEPHYR_RUNNER_CLOUD_POD = ${ZEPHYR_RUNNER_CLOUD_POD}"
 
-    - name: checkout
+    - name: Apply container owner mismatch workaround
+      run: |
+        # FIXME: The owner UID of the GITHUB_WORKSPACE directory may not
+        #        match the container user UID because of the way GitHub
+        #        Actions runner is implemented. Remove this workaround when
+        #        GitHub comes up with a fundamental fix for this problem.
+        git config --global --add safe.directory ${GITHUB_WORKSPACE}
+
+    - name: Clone cached Zephyr repository
+      continue-on-error: true
+      run: |
+        git clone --shared /repo-cache/zephyrproject/zephyr .
+        git remote set-url origin ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}
+
+    - name: Checkout
       uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         ref: ${{ github.event.pull_request.head.sha }}
         fetch-depth: 0
-        path: zephyr
 
-    - name: Rebase
-      if: github.event_name == 'pull_request'
-      continue-on-error: true
-      env:
-        BASE_REF: ${{ github.base_ref }}
-        PR_HEAD: ${{ github.event.pull_request.head.sha }}
-      working-directory: zephyr
+    - name: Environment Setup
       run: |
-        git config --global user.email "actions@zephyrproject.org"
-        git config --global user.name "Github Actions"
-        rm -fr ".git/rebase-apply"
-        rm -fr ".git/rebase-merge"
-        git rebase origin/${BASE_REF}
-        git clean -f -d
-        git log --graph --oneline HEAD...${PR_HEAD}
+        if [ "${{github.event_name}}" = "pull_request" ]; then
+          git config --global user.email "bot@zephyrproject.org"
+          git config --global user.name "Zephyr Builder"
+          rm -fr ".git/rebase-apply"
+          rm -fr ".git/rebase-merge"
+          git rebase origin/${BASE_REF}
+          git clean -f -d
+          git log  --pretty=oneline | head -n 10
+        fi
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
 
-    - name: Set up Python
-      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
-      with:
-        python-version: 3.12
-        cache: pip
-        cache-dependency-path: doc/requirements.txt
+        west init -l . || true
+        west config manifest.group-filter -- +ci,+optional
+        west config --global update.narrow true
+        west update --path-cache /repo-cache/zephyrproject 2>&1 1> west.update.log || west update --path-cache /repo-cache/zephyrproject 2>&1 1> west.update.log || ( rm -rf ../modules ../bootloader ../tools && west update --path-cache /repo-cache/zephyrproject)
+        west forall -c 'git reset --hard HEAD'
 
-    - name: Setup Zephyr project
-      uses: zephyrproject-rtos/action-zephyr-setup@c125c5ebeeadbd727fa740b407f862734af1e52a # v1.0.9
-      with:
-        app-path: zephyr
-        toolchains: 'all'
+        echo "ZEPHYR_SDK_INSTALL_DIR=/opt/toolchains/zephyr-sdk-$( cat SDK_VERSION )" >> $GITHUB_ENV
 
-    - name: install-pip
-      working-directory: zephyr
+    - name: Install Python packages required for documentation build
       run: |
+        pip install -r scripts/requirements-actions.txt --require-hashes
         pip install -r doc/requirements.txt --require-hashes
 
-    - name: build-docs
+    - name: Build HTML documentation
       shell: bash
-      working-directory: zephyr
       run: |
         if [[ "$GITHUB_REF" =~ "refs/tags/v" ]]; then
           DOC_TAG="release"
@@ -145,27 +150,26 @@ jobs:
         lcov --remove doc-coverage.info \*/deprecated > new.info
         genhtml --no-function-coverage --no-branch-coverage new.info -o coverage-report
 
-    - name: compress-docs
-      working-directory: zephyr
+    - name: Compress documentation build artifacts
       run: |
         tar --use-compress-program="xz -T0" -cf html-output.tar.xz --exclude html/_sources --exclude html/doxygen/xml --directory=doc/_build html
         tar --use-compress-program="xz -T0" -cf api-output.tar.xz --directory=doc/_build html/doxygen/html
         tar --use-compress-program="xz -T0" -cf api-coverage.tar.xz coverage-report
 
-    - name: upload-build
+    - name: Upload HTML output
       uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       with:
         name: html-output
-        path: zephyr/html-output.tar.xz
+        path: html-output.tar.xz
 
-    - name: upload-api-coverage
+    - name: Upload Doxygen coverage artifacts
       uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       with:
         name: api-coverage
-        path: zephyr/api-coverage.tar.xz
+        path: api-coverage.tar.xz
 
 
-    - name: process-pr
+    - name: Summarize PR documentation URLs
       if: github.event_name == 'pull_request'
       run: |
         REPO_NAME="${{ github.event.repository.name }}"
@@ -179,7 +183,7 @@ jobs:
         echo "API Documentation will be available shortly at: ${API_DOC_URL}" >> $GITHUB_STEP_SUMMARY
         echo "API Coverage Report will be available shortly at: ${API_COVERAGE_URL}" >> $GITHUB_STEP_SUMMARY
 
-    - name: upload-pr-number
+    - name: Upload PR number
       uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       if: github.event_name == 'pull_request'
       with:

doc/requirements.in

@@ -28,3 +28,6 @@ anytree
 
 # Used to generate API coverage reports
 coverxygen
+
+# Used by Kconfig extension
+python-dotenv