Fix release multi-version docs dependencies - #6832
Conversation
Use develop's UV test extra because docs/requirements.txt was removed.
Temporarily exercise the scheduled documentation job before merging the release-branch fix.
Restore the scheduled-only gate after the full multi-version documentation job passed on the pull request.
Greptile SummaryFixes the release branch's multi-version documentation dependency setup.
Confidence Score: 4/5The PR appears safe to merge, with the non-blocking exception that the new third-party action should be pinned to an immutable commit. The dependency setup matches the develop-based documentation build flow, but the mutable setup-uv reference permits unexpected upstream changes to affect future workflow runs. Files Needing Attention: .github/workflows/docs.yaml
|
| Filename | Overview |
|---|---|
| .github/workflows/docs.yaml | Updates only the multi-version documentation job to install the develop branch's UV-managed test dependencies; the new third-party action should be pinned immutably. |
Reviews (1): Last reviewed commit: "Revert temporary multi-version PR trigge..." | Re-trigger Greptile
| - name: Setup python | ||
| uses: actions/setup-python@v5 | ||
| - name: Set up uv | ||
| uses: astral-sh/setup-uv@v6 |
There was a problem hiding this comment.
Mutable third-party action reference
astral-sh/setup-uv@v6 allows the executed action implementation to change without a repository update, exposing scheduled and manually dispatched documentation runs to unexpected upstream changes or tag compromise. Pin this action to a reviewed full commit SHA. How this was verified: The new workflow line executes a third-party action through the mutable v6 tag.
There was a problem hiding this comment.
Isaac Lab Review Bot
The change updates only the multi-version documentation job so its dependency installation matches the checked-out develop tree, replacing the removed docs/requirements.txt path with the root UV test extra.
- Design and architecture: The checkout target and dependency source are now aligned within the multi-version job. Installing the broader root
testextra increases dependency scope, but it uses the dependency definition maintained bydevelopand leaves release-branch current-doc builds unchanged. - API: No public Python, extension, or CLI API is affected. The compatibility surface reviewed is limited to the GitHub Actions setup and the existing documentation build commands.
- Implementation: The workflow pins
astral-sh/setup-uvby major version, runsuv sync --extra testfrom the repository root, and adds the resulting root.venv/bintoGITHUB_PATHbefore invokingmake multi-docsfromdocs. No source package is touched, so no package changelog fragment is needed.
No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.
Automated review; human maintainers own approval decisions.
Description
Fix the scheduled multi-version documentation job on
release/3.0.0-beta2.The release workflow checks out
developbefore generating the multi-version site, but it still tried to installdocs/requirements.txt. That file was removed fromdevelopwhen documentation dependencies moved into the root UVtestextra, so the job failed before Sphinx started.Update only the multi-version job to use
astral-sh/setup-uv@v6anduv sync --extra test, matching the dependency setup ondevelopwhile leaving release-branch current-doc builds unchanged.Failed nightly job: https://github.com/isaac-sim/IsaacLab/actions/runs/30600776364/job/91062748798
Type of change
Verification
docs/requirements.txton the currentdeveloptip.uv sync --extra testsuccessfully in a clean checkout of the currentdeveloptip (468 packages resolved and the documentation toolchain installed).Install docs dependenciespassed.Screenshots
Not applicable.
Checklist
source/<pkg>/package is touched.CONTRIBUTORS.md.