Skip to content

Adds release/3.0.0-beta2 to docs#5714

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
kellyguo11:release-doc-build
May 21, 2026
Merged

Adds release/3.0.0-beta2 to docs#5714
kellyguo11 merged 1 commit into
isaac-sim:developfrom
kellyguo11:release-doc-build

Conversation

@kellyguo11

Copy link
Copy Markdown
Contributor

Description

Adds new release/3.0.0-beta2 to the docs for the QA cycle. This will be the new release branch as we prepare for the Isaac Lab 3.0.0 Beta 2 release.

Type of change

  • Documentation update

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

@kellyguo11 kellyguo11 requested a review from hhansen-bdai as a code owner May 21, 2026 00:02
@github-actions github-actions Bot added documentation Improvements or additions to documentation infrastructure labels May 21, 2026

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🤖 Isaac Lab Review Bot

Summary

This PR adds the release/3.0.0-beta2 branch to the documentation build whitelist and updates the README compatibility table for the upcoming Isaac Lab 3.0.0 Beta 2 release.

Changes Reviewed

.github/workflows/docs.yaml

Regex pattern update looks correct. The SMV_BRANCH_WHITELIST regex ^(main|develop|release/3\.0\.0-beta2)$ properly escapes the dots and will correctly match only the intended branch.

📝 Minor consideration: The comment mentions "most release/ branches are excluded" which is accurate and provides good context for future maintainers.

README.md

Version table entry is consistent with the existing format. The v3.0.0* wildcard pattern and Isaac Sim 6.0 association follows the established convention.

CI Status

  • Pre-commit checks: ✅ Passed
  • License check: ⏳ Pending
  • Build Latest Docs: ⏳ Pending

Most other checks are skipping (expected for documentation-only changes).

Recommendations

  1. No blocking issues found. This is a straightforward documentation update.
  2. Once the pending CI jobs complete (especially "Build Latest Docs"), the changes should be ready for merge.
  3. Consider verifying the version switcher renders correctly after the docs build completes.

Review based on commit 3effbca

@greptile-apps

greptile-apps Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds release/3.0.0-beta2 to the documentation build pipeline in preparation for the Isaac Lab 3.0.0 Beta 2 QA cycle, and updates the README version-compatibility table to reflect the new 3.x release family.

  • docs.yaml: SMV_BRANCH_WHITELIST is extended with release/3\\.0\\.0-beta2 (dots correctly escaped) so the branch appears in the docs version switcher during the multi-version build; the existing trigger condition already fires for any release/ push, so no other workflow logic changes were needed.
  • README.md: A v3.0.0* row is inserted between main and v2.3.X in the Isaac Sim dependency table, correctly associating the upcoming 3.x release family with Isaac Sim 6.0.

Confidence Score: 5/5

Safe to merge — changes are confined to a regex whitelist update in the docs workflow and a one-row addition to the README table, neither of which affects runtime code.

Both changes are minimal and correct: the regex escaping in SMV_BRANCH_WHITELIST is proper, the new branch name matches the intended release/3.0.0-beta2 branch exactly, and the README row is placed in the right chronological position. No logic, tests, or runtime code is touched.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/docs.yaml Adds release/3.0.0-beta2 to SMV_BRANCH_WHITELIST regex so the beta2 branch appears in the docs version switcher during the QA cycle.
README.md Adds a v3.0.0* row to the Isaac Sim version compatibility table, correctly placed above the v2.x entries.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Push to branch] --> B{Is deploy branch?}
    B -- "main / develop / release/*" --> C[Trigger multi-version build]
    B -- other branch --> D[Build current-version docs only]
    C --> E{SMV_BRANCH_WHITELIST match?}
    E -- "main | develop | release/3.0.0-beta2" --> F[Include in version switcher]
    E -- other release/* --> G[Build triggered, but NOT in switcher]
    F --> H[Deploy to gh-pages]
    G --> H
Loading

Reviews (1): Last reviewed commit: "Adds release/3.0.0-beta2 to docs" | Re-trigger Greptile

@kellyguo11 kellyguo11 merged commit 697eca5 into isaac-sim:develop May 21, 2026
39 checks passed
mmichelis pushed a commit to mmichelis/IsaacLab that referenced this pull request May 22, 2026
# Description

Adds new release/3.0.0-beta2 to the docs for the QA cycle. This will be
the new release branch as we prepare for the Isaac Lab 3.0.0 Beta 2
release.

## Type of change

- Documentation update


## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] 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

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
moennen pushed a commit to moennen/IsaacLab that referenced this pull request May 25, 2026
# Description

Adds new release/3.0.0-beta2 to the docs for the QA cycle. This will be
the new release branch as we prepare for the Isaac Lab 3.0.0 Beta 2
release.

## Type of change

- Documentation update


## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] 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

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
kellyguo11 added a commit that referenced this pull request May 26, 2026
… fix (#5757) (#5774)

# Description

Cherry pick two changes from develop:

- [Adds release/3.0.0-beta2 to docs
](#5714) #5714
- [Fixes ARM64 docker build issue + re-enables JUnit artifacts (for
sidecar service)](#5757) #5757


## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

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

## Checklist

- [ ] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) 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

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

---------

Co-authored-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
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.

1 participant