ci: Allow repo to self publish docs

[chtruong814]

What does this PR do ?

Allow repo to self publish docs by building and pushing to s3.

Issues

List issues that this PR closes (syntax):

Usage

• You can potentially add a usage example below

# Add a code snippet demonstrating how to use this

Before your PR is "Ready for review"

Pre checks:

• Make sure you read and followed Contributor guidelines
• Did you write any new necessary tests?
• Did you run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
• Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

• ...

Summary by CodeRabbit

• Chores
  • Added automated documentation release workflow with support for versioned builds, dry-run testing, and email notifications for streamlined documentation deployment.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

A new GitHub Actions workflow "Release docs" is introduced that orchestrates documentation building and publishing with support for dry-run mode, version tagging, email notifications, and S3 artifact management on AWS.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflow \.github/workflows/release-docs.yml	New workflow with two sequential jobs: build-docs (reuses external template v0.67.0) and publish-docs (runs on ubuntu-latest, depends on build-docs, checks out FW-CI-templates v0.67.2, publishes to S3 with dry-run support and conditional versioning based on branch/tag)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Test Results For Major Changes	⚠️ Warning	The PR introduces a new GitHub Actions workflow for documentation publishing, but lacks test results or evidence validating the workflow functions correctly.	Add documentation showing workflow testing results, S3 publication confirmation, email notification validation, and address the unused version-number input.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title clearly and concisely describes the main change: introducing CI capability for self-publishing documentation to S3.
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.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @.github/workflows/release-docs.yml:
- Around line 23-27: Remove the unused required workflow input named
"version-number" from the workflow inputs block (it's currently declared
alongside "notify-emails") because the publish-docs logic auto-detects the
version from the git ref and never consumes this input; update the inputs
section to delete the "version-number" entry so manual dispatchers aren't
required to provide it and ensure no other steps reference "version-number".

🧹 Nitpick comments (1)

.github/workflows/release-docs.yml (1)

39-40: Align template versions for consistent publish-docs behavior.

Line 39 uses [email protected], while the publish-docs step (lines 47–48, 51) uses v0.67.2. Version v0.67.2 includes a bug fix for publishing to latest, making the version skew problematic. Update line 39 to v0.67.2 to ensure consistent behavior across build and publish stages.

Suggested alignment

-  build-docs:
-    uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/[email protected]
+  build-docs:
+    uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/[email protected]

Also consider pinning external workflow and action references to commit SHAs instead of tags to prevent tag retargeting risks when running with secrets.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Find and read the workflow file
find . -name "release-docs.yml" -type f | head -20

Repository: NVIDIA-NeMo/RL

Length of output: 94

---

🏁 Script executed:

# Also check the directory structure
git ls-files | grep -E "\.github/workflows" | head -20

Repository: NVIDIA-NeMo/RL

Length of output: 812

---

🏁 Script executed:

cat -n .github/workflows/release-docs.yml

Repository: NVIDIA-NeMo/RL

Length of output: 3587

---

🏁 Script executed:

# Search for any references to "version-number" in the workflow file to confirm it's truly unused
rg "version-number" .github/workflows/release-docs.yml

Repository: NVIDIA-NeMo/RL

Length of output: 79

---

🏁 Script executed:

# Check if there's any documentation or action definition for publish-docs in the repo
find . -name "publish-docs*" -type f | head -20

Repository: NVIDIA-NeMo/RL

Length of output: 40

---

🏁 Script executed:

# Search for publish-docs action references across workflows
rg "publish-docs" .github/workflows/ -A 5 -B 2

Repository: NVIDIA-NeMo/RL

Length of output: 2024

---

Remove unused required input version-number to avoid confusing workflow dispatchers.

The version-number input defined at lines 23–27 is never passed to the publish-docs action. The workflow auto-detects the version from the git reference (publishing to "latest" for main, or extracting from version tags). Remove this input to prevent misleading users during manual workflow dispatch.

Suggested fix

-      version-number:
-        description: Version number to release this as (use `latest` for main branch)
-        required: true
-        type: string

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	version-number:
	description: Version number to release this as (use `latest` for main branch)
	required: true
	type: string
	notify-emails:
	notify-emails:

🤖 Prompt for AI Agents

In @.github/workflows/release-docs.yml around lines 23 - 27, Remove the unused
required workflow input named "version-number" from the workflow inputs block
(it's currently declared alongside "notify-emails") because the publish-docs
logic auto-detects the version from the git ref and never consumes this input;
update the inputs section to delete the "version-number" entry so manual
dispatchers aren't required to provide it and ensure no other steps reference
"version-number".

[terrykong]

does this need to be exposed?

[chtruong814]

That's fair. Should just be an env var. I doubt it's a value that changes by repo

[terrykong]

should this be inferred from the code? also how does pushing the docs for each "version" work?

[chtruong814]

I'll remove this. It's not used. The workflow actually uses the version from the Github version tag when the workflow is ran. If it's a Github tag, then it'll push the docs according to that tag as the version. Otherwise, if it's main branch, it'll push to "latest".

The version just changes the path in the s3 bucket.