Skip to content

Fix release multi-version docs dependencies - #6832

Merged
kellyguo11 merged 3 commits into
isaac-sim:release/3.0.0-beta2from
kellyguo11:kellyguo11/fix-release-doc-nightly
Jul 31, 2026
Merged

Fix release multi-version docs dependencies#6832
kellyguo11 merged 3 commits into
isaac-sim:release/3.0.0-beta2from
kellyguo11:kellyguo11/fix-release-doc-nightly

Conversation

@kellyguo11

@kellyguo11 kellyguo11 commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Description

Fix the scheduled multi-version documentation job on release/3.0.0-beta2.

The release workflow checks out develop before generating the multi-version site, but it still tried to install docs/requirements.txt. That file was removed from develop when documentation dependencies moved into the root UV test extra, so the job failed before Sphinx started.

Update only the multi-version job to use astral-sh/setup-uv@v6 and uv sync --extra test, matching the dependency setup on develop while leaving release-branch current-doc builds unchanged.

Failed nightly job: https://github.com/isaac-sim/IsaacLab/actions/runs/30600776364/job/91062748798

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Verification

  • Confirmed the old command cannot find docs/requirements.txt on the current develop tip.
  • Ran uv sync --extra test successfully in a clean checkout of the current develop tip (468 packages resolved and the documentation toolchain installed).
  • Temporarily enabled the multi-version job for this pull request and ran it end to end: https://github.com/isaac-sim/IsaacLab/actions/runs/30652411009/job/91228818769
    • Install docs dependencies passed.
    • All selected documentation versions built successfully.
    • Default-version validation and the GitHub Pages artifact upload passed.
    • The job completed successfully in 1h 3m 56s, and deployment remained skipped.
  • Reverted the temporary pull-request trigger after the successful run; the aggregate diff contains only the release dependency fix.
  • Ran the full repository pre-commit suite before each commit and push; all hooks passed, including YAML validation.

Screenshots

Not applicable.

Checklist

  • I have read and understood the contribution guidelines.
  • I have run the pre-commit checks with the repository formatting command.
  • No user-facing documentation update is required for this workflow-only fix.
  • The change generates no new static-check warnings.
  • I verified the replacement dependency command and the full multi-version job.
  • No package changelog fragment is required because no source/<pkg>/ package is touched.
  • My name already exists in CONTRIBUTORS.md.

Use develop's UV test extra because docs/requirements.txt was removed.
@github-actions github-actions Bot added bug Something isn't working infrastructure labels Jul 31, 2026
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.
@kellyguo11
kellyguo11 marked this pull request as ready for review July 31, 2026 20:20
@kellyguo11
kellyguo11 requested a review from a team July 31, 2026 20:20
@kellyguo11
kellyguo11 merged commit 6a7acb0 into isaac-sim:release/3.0.0-beta2 Jul 31, 2026
38 checks passed
@greptile-apps

greptile-apps Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Fixes the release branch's multi-version documentation dependency setup.

  • Replaces setup-python and the removed docs requirements installation with setup-uv.
  • Synchronizes the develop checkout's test extra and exposes its virtual environment to later documentation commands.

Confidence Score: 4/5

The 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

Security Review

The new setup-uv action is referenced by a mutable major-version tag, allowing its executed implementation to change without a repository update.

Important Files Changed

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 security 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.

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 test extra increases dependency scope, but it uses the dependency definition maintained by develop and 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-uv by major version, runs uv sync --extra test from the repository root, and adds the resulting root .venv/bin to GITHUB_PATH before invoking make multi-docs from docs. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant