Skip to content

Fixes stale single-source references for dependency pins#6597

Open
myurasov-nv wants to merge 1 commit into
isaac-sim:developfrom
myurasov-nv:my-pin-single-source
Open

Fixes stale single-source references for dependency pins#6597
myurasov-nv wants to merge 1 commit into
isaac-sim:developfrom
myurasov-nv:my-pin-single-source

Conversation

@myurasov-nv

Copy link
Copy Markdown
Member

Description

Fixes three references that drifted from the single-source-of-truth root pyproject.toml: the wheel builder comment pointed at python_packages.toml (removed long ago), daily-compatibility.yml parsed [tool.isaaclab.versions] with a hand-written regex (now tomllib, byte-identical output), and the pip-installation docs claimed rl_games is excluded from the wheel extras while gen_pyproject.py actually includes it in all/rl-games.

Before After
Wheel builder comment references nonexistent python_packages.toml describes the actual copy step
OV pins in daily-compatibility regex over raw TOML text tomllib parse
Docs all extra "SB3, SKRL, RSL-RL" full list incl. RL-Games, Rerun, Mimic, RLinf

Reproduction

  1. grep python_packages.toml -r . returns only the stale comment; no such file exists.
  2. python3 tools/wheel_builder/gen_pyproject.py pyproject.toml /tmp/p.toml 1.2.3 && grep rl-games /tmp/p.toml shows rl_games in the rl-games and all extras, contradicting the docs note.
  3. Run both the old regex and new tomllib snippets against pyproject.toml: identical output.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

The root pyproject.toml is the single source of truth for dependency
pins, but three references to it have gone stale:

- The wheel-builder comment referenced python_packages.toml, a manifest
  that no longer exists.
- daily-compatibility.yml parsed [tool.isaaclab.versions] with a hand
  written regex; use tomllib for the same output with real TOML parsing.
- The pip-installation docs claimed rl_games is not included in the
  wheel extras, but gen_pyproject.py expands the all extra with
  rl-games (from the isaac-sim git branch) along with Rerun, Mimic,
  and RLinf.
@github-actions github-actions Bot added documentation Improvements or additions to documentation infrastructure labels Jul 18, 2026
@myurasov-nv
myurasov-nv marked this pull request as ready for review July 18, 2026 01:47
@myurasov-nv
myurasov-nv requested a review from a team July 18, 2026 01:47
@greptile-apps

greptile-apps Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes three stale references that had drifted from the single-source-of-truth pyproject.toml: a dead comment in the wheel builder, a hand-rolled regex TOML parser in the daily-compatibility workflow, and outdated pip-installation docs that incorrectly excluded rl_games from the wheel extras.

  • build.sh: Comment updated from a reference to the deleted python_packages.toml to an accurate description of the copy step.
  • daily-compatibility.yml: The fragile regex TOML parser is replaced with tomllib (stdlib since Python 3.11, guaranteed by the project's >=3.12 constraint), producing byte-identical output with no behavioral change.
  • isaaclab_pip_installation.rst: The all extra description and the rl_games note are corrected to reflect the actual generated pyproject.tomlrl_games is included, and users are informed that git must be available at install time.

Confidence Score: 5/5

All three changes are safe to merge: two are comment/doc corrections and the third is a drop-in stdlib replacement with identical runtime output.

The tomllib swap is a clean improvement — it eliminates a fragile multi-line regex, produces byte-identical output, and is backed by stdlib (guaranteed available given the project's Python 3.12 pin). The docs and comment fixes simply align written text with the code that already existed. No logic is altered, no new dependencies are introduced, and no existing behavior changes.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/daily-compatibility.yml Replaces hand-rolled regex TOML parsing with stdlib tomllib; functionally equivalent and safer for nested/quoted values.
docs/source/setup/installation/isaaclab_pip_installation.rst Updates the all extra description and corrects the rl_games note to reflect that it is included in the wheel extras via all/rl-games.
tools/wheel_builder/build.sh Single-line comment fix removing the reference to the long-deleted python_packages.toml.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[pyproject.toml\nsingle source of truth] --> B[tool.isaaclab.versions]
    A --> C[tool.isaaclab extras\nrl-games / all]

    B --> D[daily-compatibility.yml\ntomllib parse]
    D --> E[ovphysx / ovrtx pins\npassed to Docker build]

    C --> F[gen_pyproject.py\nwheel builder]
    F --> G[Generated wheel pyproject.toml\nincludes rl_games in all + rl-games]

    G --> H[isaaclab_pip_installation.rst\nnow accurately documents\nall extra incl. RL-Games]

    I[build.sh comment] -.->|was referencing| J[python_packages.toml\ndeleted file ❌]
    I -->|now describes| K[actual copy step\napps/ + source/ ✅]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[pyproject.toml\nsingle source of truth] --> B[tool.isaaclab.versions]
    A --> C[tool.isaaclab extras\nrl-games / all]

    B --> D[daily-compatibility.yml\ntomllib parse]
    D --> E[ovphysx / ovrtx pins\npassed to Docker build]

    C --> F[gen_pyproject.py\nwheel builder]
    F --> G[Generated wheel pyproject.toml\nincludes rl_games in all + rl-games]

    G --> H[isaaclab_pip_installation.rst\nnow accurately documents\nall extra incl. RL-Games]

    I[build.sh comment] -.->|was referencing| J[python_packages.toml\ndeleted file ❌]
    I -->|now describes| K[actual copy step\napps/ + source/ ✅]
Loading

Reviews (1): Last reviewed commit: "Fix stale single-source references for d..." | Re-trigger Greptile

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

Labels

documentation Improvements or additions to documentation infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants