fix: revert "ci: remove redundant docs workflow" by miyoungc · Pull Request #856 · NVIDIA/NemoClaw

miyoungc · 2026-03-25T02:50:12Z

Reverts #725

Summary by CodeRabbit

Chores
- Added automated documentation validation to pull requests that modify documentation files, configuration files, and related workflows.

This reverts commit b18627f.

coderabbitai · 2026-03-25T02:50:28Z

📝 Walkthrough

Walkthrough

A new GitHub Actions workflow file has been added to automatically validate documentation on pull requests. The workflow triggers on changes to documentation, README, dependencies, or the workflow itself, installing dependencies and building Sphinx documentation in strict mode with a 10-minute execution limit.

Changes

Cohort / File(s)	Summary
Documentation Workflow `.github/workflows/docs.yaml`	New GitHub Actions workflow that validates documentation builds. Triggers on `docs/**`, `README.md`, `pyproject.toml`, `uv.lock`, and the workflow file. Installs Python 3.11, sets up uv, syncs docs dependencies, and builds Sphinx HTML output with strict mode enabled (`-W` flag).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A workflow emerges, so bright and so new,
Docs build with strictness, through and through,
With Python and Sphinx in harmonious dance,
Ten minutes to verify every glance,
Our documentation blooms, thanks to this chance! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: reverting a previous commit that removed a docs workflow, and the new file additions confirm this intent.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch revert-725-ci/remove-duplicate-workflows

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

ericksoa

LGTM — straightforward revert restoring the docs build validation on PRs.

coderabbitai

🧹 Nitpick comments (2)

.github/workflows/docs.yaml (2)
39-40: Use --locked flag to enforce reproducible CI builds.

Line 40 should explicitly enforce that the lockfile is up to date and prevent it from being modified during installation. Use --locked to fail if uv.lock is out of sync with pyproject.toml, ensuring deterministic behavior in CI.
Suggested change
      - name: Install doc dependencies
-       run: uv sync --group docs
+       run: uv sync --group docs --locked
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/docs.yaml around lines 39 - 40, Update the "Install doc
dependencies" step so the install command uses the --locked flag to enforce the
lockfile; specifically modify the command referenced ("uv sync --group docs") to
"uv sync --group docs --locked" so CI fails if uv.lock is out of sync with
pyproject.toml and prevents lockfile changes during the run.
29-37: Pin external actions to immutable SHAs for stronger supply-chain integrity.

Lines 29, 32, and 37 use floating major version tags. SHA pinning (e.g., actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v6.2.0) is GitHub's recommended best practice for supply-chain security, as version tags are mutable and can be updated to point to malicious code. Pinning to commit SHAs prevents this risk, particularly for third-party actions like astral-sh/setup-uv@v7. Consider adding comments with the corresponding version tag to allow automated tools like Dependabot to track updates.

Note: This pattern appears across multiple workflows in the repository; consider standardizing as part of a repo-wide security hardening effort.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/docs.yaml around lines 29 - 37, The workflow uses floating
major-version tags for external actions (actions/checkout@v6,
actions/setup-python@v6, astral-sh/setup-uv@v7); replace each action reference
with the corresponding immutable commit SHA (pin to the action's full commit
hash) and optionally keep the human-readable tag as a comment (e.g., "# v6.2.0")
so Dependabot/maintainers can track updates; apply the same SHA-pinning pattern
for any other workflows that reference third-party actions to harden
supply-chain security.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/docs.yaml:
- Around line 39-40: Update the "Install doc dependencies" step so the install
command uses the --locked flag to enforce the lockfile; specifically modify the
command referenced ("uv sync --group docs") to "uv sync --group docs --locked"
so CI fails if uv.lock is out of sync with pyproject.toml and prevents lockfile
changes during the run.
- Around line 29-37: The workflow uses floating major-version tags for external
actions (actions/checkout@v6, actions/setup-python@v6, astral-sh/setup-uv@v7);
replace each action reference with the corresponding immutable commit SHA (pin
to the action's full commit hash) and optionally keep the human-readable tag as
a comment (e.g., "# v6.2.0") so Dependabot/maintainers can track updates; apply
the same SHA-pinning pattern for any other workflows that reference third-party
actions to harden supply-chain security.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0a9b1e74-6855-42e5-8448-4e9a6b7185e5

📥 Commits

Reviewing files that changed from the base of the PR and between 280227f and 8903e45.

📒 Files selected for processing (1)

.github/workflows/docs.yaml

This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(ci): post docs preview comment with explicit PR number The workflow_run context has no github.event.pull_request.number, so rossjrw/pr-preview-action's internal sticky comment silently skips posting. Disable its built-in comment and add an explicit marocchino/sticky-pull-request-comment step that passes the PR number from the artifact metadata. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * test: test * fix: remove test * ci: revert "revert ci: remove redundant docs workflow (#725)" (#856) This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>

This reverts commit b18627f.

* fix(ci): post docs preview comment with explicit PR number The workflow_run context has no github.event.pull_request.number, so rossjrw/pr-preview-action's internal sticky comment silently skips posting. Disable its built-in comment and add an explicit marocchino/sticky-pull-request-comment step that passes the PR number from the artifact metadata. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * test: test * fix: remove test * ci: revert "revert ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856) This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>

This reverts commit b18627f.

* fix(ci): post docs preview comment with explicit PR number The workflow_run context has no github.event.pull_request.number, so rossjrw/pr-preview-action's internal sticky comment silently skips posting. Disable its built-in comment and add an explicit marocchino/sticky-pull-request-comment step that passes the PR number from the artifact metadata. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * test: test * fix: remove test * ci: revert "revert ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856) This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>

This reverts commit b18627f.

* fix(ci): post docs preview comment with explicit PR number The workflow_run context has no github.event.pull_request.number, so rossjrw/pr-preview-action's internal sticky comment silently skips posting. Disable its built-in comment and add an explicit marocchino/sticky-pull-request-comment step that passes the PR number from the artifact metadata. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * test: test * fix: remove test * ci: revert "revert ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856) This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>

Revert "ci: remove redundant docs workflow (#725)"

8903e45

This reverts commit b18627f.

miyoungc requested review from cv and ericksoa March 25, 2026 02:51

miyoungc self-assigned this Mar 25, 2026

miyoungc added documentation labels Mar 25, 2026

ericksoa approved these changes Mar 25, 2026

View reviewed changes

coderabbitai Bot reviewed Mar 25, 2026

View reviewed changes

ericksoa merged commit 36fa334 into main Mar 25, 2026
7 checks passed

cv deleted the revert-725-ci/remove-duplicate-workflows branch March 25, 2026 02:56

cv added a commit that referenced this pull request Mar 25, 2026

ci: revert "revert ci: remove redundant docs workflow (#725)" (#856)

73b5ea0

This reverts commit 36fa334. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

temrjan pushed a commit to temrjan/NemoClaw that referenced this pull request Mar 25, 2026

Revert "ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856)

fc9210c

This reverts commit b18627f.

lakamsani pushed a commit to lakamsani/NemoClaw that referenced this pull request Apr 4, 2026

Revert "ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856)

30b942f

This reverts commit b18627f.

jyaunches mentioned this pull request Apr 16, 2026

bug(onboard): Onboard does not detect or recover from TLS cert errors during sandbox create #1933

Closed

jacobtomlinson pushed a commit to jacobtomlinson/NemoClaw that referenced this pull request Apr 30, 2026

Revert "ci: remove redundant docs workflow (NVIDIA#725)" (NVIDIA#856)

7b39643

This reverts commit b18627f.

wscurran added area: ci CI workflows, checks, release automation, or GitHub Actions chore Build, CI, dependency, or tooling maintenance area: docs Documentation, examples, guides, or docs build and removed CI/CD labels Jun 3, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: revert "ci: remove redundant docs workflow"#856

fix: revert "ci: remove redundant docs workflow"#856
ericksoa merged 1 commit into
mainfrom
revert-725-ci/remove-duplicate-workflows

miyoungc commented Mar 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Mar 25, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

ericksoa left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

miyoungc commented Mar 25, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

ericksoa left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

miyoungc commented Mar 25, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 25, 2026 •

edited

Loading