From 9d5fbfe2995f3f81ecef58cb1b9f031e1d930106 Mon Sep 17 00:00:00 2001 From: Charlie Truong Date: Thu, 24 Jul 2025 20:22:51 -0500 Subject: [PATCH 1/4] Add build-docs CI check Signed-off-by: Charlie Truong --- .github/workflows/build-docs.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000000..18629d21dd --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,28 @@ +# Copyright (c) 2025, NVIDIA CORPORATION. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Build docs + +on: + pull_request: + branches: + - "main" + - "r**" + types: [labeled, opened, synchronize, reopened] + merge_group: + types: [checks_requested] + +jobs: + build-docs: + uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.48.0 From 9625985cf7c6690c60d02e0bc79a986a07695a13 Mon Sep 17 00:00:00 2001 From: Charlie Truong Date: Mon, 28 Jul 2025 16:42:33 -0500 Subject: [PATCH 2/4] Update sphinx-build to use build_docs template Signed-off-by: Charlie Truong --- .github/workflows/cicd-main.yml | 28 +--------------------------- 1 file changed, 1 insertion(+), 27 deletions(-) diff --git a/.github/workflows/cicd-main.yml b/.github/workflows/cicd-main.yml index 3b10108e6a..4244bc8f40 100644 --- a/.github/workflows/cicd-main.yml +++ b/.github/workflows/cicd-main.yml @@ -168,33 +168,7 @@ jobs: run: uv cache prune --ci sphinx-build: - if: ${{ needs.pre-flight.outputs.test_level != 'none' }} - name: Sphinx build - needs: [pre-flight] - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - submodules: 'recursive' - - name: Install uv - uses: astral-sh/setup-uv@v5 - with: - version: "0.7.2" - enable-cache: true - prune-cache: false - # Faster than uv python install since it caches python alongside runner - - name: "Set up Python" - uses: actions/setup-python@v5 - with: - python-version-file: ".python-version" - - name: build docs - run: | - uv venv - cd docs/ - uv run --group docs sphinx-build --fail-on-warning --builder html . _build/html - - name: Minimize uv cache - run: uv cache prune --ci + uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.48.0 build-container: if: ${{ needs.pre-flight.outputs.test_level != 'none' }} From 0b8935f52edd1991cb1b3faf14a918ea7faaf57d Mon Sep 17 00:00:00 2001 From: Charlie Truong Date: Mon, 28 Jul 2025 16:44:36 -0500 Subject: [PATCH 3/4] Add condition to sphinx-build Signed-off-by: Charlie Truong --- .github/workflows/cicd-main.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/cicd-main.yml b/.github/workflows/cicd-main.yml index 4244bc8f40..5924878e1b 100644 --- a/.github/workflows/cicd-main.yml +++ b/.github/workflows/cicd-main.yml @@ -168,6 +168,8 @@ jobs: run: uv cache prune --ci sphinx-build: + needs: [pre-flight] + if: ${{ needs.pre-flight.outputs.test_level != 'none' }} uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.48.0 build-container: From 613a1b6286236cde06fd8f1e42848d11e129e014 Mon Sep 17 00:00:00 2001 From: Charlie Truong Date: Mon, 28 Jul 2025 16:45:51 -0500 Subject: [PATCH 4/4] Remove separate build-docs workflow Signed-off-by: Charlie Truong --- .github/workflows/build-docs.yml | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml deleted file mode 100644 index 18629d21dd..0000000000 --- a/.github/workflows/build-docs.yml +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright (c) 2025, NVIDIA CORPORATION. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -name: Build docs - -on: - pull_request: - branches: - - "main" - - "r**" - types: [labeled, opened, synchronize, reopened] - merge_group: - types: [checks_requested] - -jobs: - build-docs: - uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.48.0