Update environment catalog and task IDs #18939
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright (c) 2022-2026, The Isaac Lab Project Developers (https://github.com/isaac-sim/IsaacLab/blob/main/CONTRIBUTORS.md). | |
| # All rights reserved. | |
| # | |
| # SPDX-License-Identifier: BSD-3-Clause | |
| name: Docs | |
| on: | |
| # Pushes and PRs still build current-docs (build-latest-docs). The expensive | |
| # multi-version deploy is owned by the nightly cron (registered on main); see | |
| # the trigger-deploy gate below — develop / release pushes no longer deploy here. | |
| push: | |
| branches: | |
| - main | |
| - develop | |
| - 'release/**' | |
| - 'feature/isaacsim-6-0' | |
| pull_request: | |
| # we're skipping the branches and paths filter to allow docs to be built on any PR because heredoc is used | |
| # additionally, we have a check that determines what version of docs will be built | |
| types: [opened, synchronize, reopened] | |
| # Nightly multi-version rebuild + deploy from develop tip. Picks up every | |
| # develop commit accumulated since the previous nightly in a single run. | |
| schedule: | |
| - cron: '0 2 * * *' # 6pm PST / 7pm PDT | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | |
| jobs: | |
| doc-build-type: | |
| name: Detect Doc Build Type | |
| runs-on: ubuntu-latest | |
| outputs: | |
| trigger-deploy: ${{ steps.trigger-deploy.outputs.defined }} | |
| steps: | |
| - id: info | |
| run: echo "repo=github.repository=${{ github.repository }}, ref=github.ref=${{ github.ref }}" | |
| - id: trigger-deploy | |
| env: | |
| REPO_NAME: ${{ secrets.REPO_NAME }} | |
| # Multi-version deploy is owned by the nightly cron (registered on main). | |
| # schedule / workflow_dispatch only fire from the default branch (main), so on | |
| # this branch these are always false: develop / release / feature pushes and PRs | |
| # build current-docs only and never deploy here. | |
| if: "${{ github.repository == env.REPO_NAME && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') }}" | |
| run: echo "defined=true" >> "$GITHUB_OUTPUT"; echo "Docs will be built multi-version and deployed" | |
| build-latest-docs: | |
| name: Build Latest Docs | |
| runs-on: ubuntu-latest | |
| needs: [doc-build-type] | |
| # run on non-deploy branches to build current version docs only | |
| if: needs.doc-build-type.outputs.trigger-deploy != 'true' | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dev requirements | |
| run: | | |
| uv venv | |
| uv pip install -r docs/requirements.txt | |
| echo "$PWD/.venv/bin" >> "$GITHUB_PATH" | |
| - name: Build current version docs | |
| working-directory: ./docs | |
| run: make current-docs | |
| - name: Upload docs artifact | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: docs-html | |
| path: ./docs/_build | |
| build-multi-docs: | |
| name: Build Multi-Version Docs | |
| runs-on: ubuntu-latest | |
| needs: [doc-build-type] | |
| # run on deploy branches to create multi-version docs | |
| if: needs.doc-build-type.outputs.trigger-deploy == 'true' | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dev requirements | |
| run: | | |
| uv venv | |
| uv pip install -r docs/requirements.txt | |
| echo "$PWD/.venv/bin" >> "$GITHUB_PATH" | |
| - name: Generate multi-version docs | |
| working-directory: ./docs | |
| env: | |
| # "deploy" branches build the full set of versions so every page | |
| # has a complete version dropdown: main, develop, tags >= v2.0.0 | |
| # (including pre-release suffixes like -beta or -rc1). v1.x tags and | |
| # most release/ branches are excluded; release/3.0.0-beta2 is included | |
| # explicitly to surface it in the version switcher. | |
| SMV_BRANCH_WHITELIST: '^(main|develop|release/3\.0\.0-beta2)$' | |
| SMV_TAG_WHITELIST: '^v[2-9]\d*\.\d+\.\d+(-[A-Za-z0-9.]+)?$' | |
| run: | | |
| git fetch --prune --unshallow --tags | |
| git checkout --detach HEAD | |
| git for-each-ref --format="%(refname:short)" refs/heads/ | xargs -r git branch -D | |
| make multi-docs | |
| - name: Upload docs artifact | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: docs-html | |
| path: ./docs/_build | |
| deploy-docs: | |
| name: Deploy Docs | |
| runs-on: ubuntu-latest | |
| needs: [doc-build-type, build-multi-docs] | |
| # deploy only on "deploy" branches | |
| if: needs.doc-build-type.outputs.trigger-deploy == 'true' | |
| steps: | |
| - name: Download docs artifact | |
| uses: actions/download-artifact@v8 | |
| with: | |
| name: docs-html | |
| path: ./docs/_build | |
| - name: Deploy to gh-pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build | |
| keep_files: false |