ci: Add release docs workflow

[thomasdhc]

Description

Add automation that releases docs

Usage

# Add snippet demonstrating usage

Checklist

• I am familiar with the Contributing Guide.
• New or Existing tests cover these changes.
• The documentation is up to date with these changes.

[greptile-apps]

Greptile Overview

Greptile Summary

Adds a new GitHub Actions workflow for automated documentation releases to Akamai CDN via AWS S3, triggered manually with dry-run support and email notifications.

• New release-docs.yml workflow with manual trigger (workflow_dispatch)
• Integrates with NVIDIA-NeMo FW-CI-templates for building and publishing docs
• Supports dry-run mode, configurable AWS region, and email notifications
• Version mismatch between reusable workflow reference (@v0.67.0) and checkout ref (v0.67.2) needs correction
• Unused version-number input parameter should be removed or utilized

Confidence Score: 4/5

• Safe to merge after fixing the version mismatch on line 39
• The workflow is well-structured and follows GitHub Actions best practices. The main issue is the version mismatch between the reusable workflow call (@v0.67.0) and the checkout reference (v0.67.2), which should be aligned for consistency. The unused version-number input is minor but indicates incomplete implementation. The workflow properly handles secrets and uses established FW-CI-templates patterns. Overall functional and secure, just needs the version alignment fix.
• .github/workflows/release-docs.yml requires version alignment between line 39 and line 48

Important Files Changed

Filename	Overview
.github/workflows/release-docs.yml	New workflow for automated docs release with version mismatch and unused input parameter

Sequence Diagram

sequenceDiagram
    participant User
    participant GHA as GitHub Actions
    participant BuildJob as build-docs job
    participant PublishJob as publish-docs job
    participant FWCI as FW-CI-templates
    participant AWS as AWS S3
    participant Akamai as Akamai CDN
    
    User->>GHA: Trigger workflow_dispatch<br/>(dry-run, version-number, notify-emails, aws-region)
    GHA->>BuildJob: Start build-docs
    BuildJob->>FWCI: Call _build_docs.yml@v0.67.0
    FWCI-->>BuildJob: Build docs artifacts
    BuildJob-->>GHA: Upload docs-html artifacts
    
    GHA->>PublishJob: Start publish-docs (needs: build-docs)
    PublishJob->>FWCI: Checkout FW-CI-templates@v0.67.2
    PublishJob->>FWCI: Call publish-docs action
    FWCI->>AWS: Upload docs to S3 (nemo/curator)
    FWCI->>Akamai: Publish to CDN
    FWCI-->>PublishJob: Send email notifications
    PublishJob-->>GHA: Complete
    GHA-->>User: Workflow complete

Loading

[greptile-apps]

_{3 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

Version mismatch between reusable workflow (@v0.67.0 on line 39) and checkout ref (v0.67.2 on line 48). Should use the same version for consistency.

Suggested change

	uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.67.0
	publish-docs:
	runs-on: ubuntu-latest
	needs: [build-docs]
	steps:
	- uses: actions/checkout@v6
	with:
	repository: NVIDIA-NeMo/FW-CI-templates
	ref: v0.67.2
	build-docs:
	uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.67.2
	publish-docs:
	runs-on: ubuntu-latest
	needs: [build-docs]
	steps:
	- uses: actions/checkout@v6
	with:
	repository: NVIDIA-NeMo/FW-CI-templates
	ref: v0.67.2

_{Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!}

[greptile-apps]

version-number input is never used in the workflow. The version is determined automatically from the branch/tag name in the publish-docs action (line 63). Consider removing this unused input or documenting why it's defined but not used.

[greptile-apps]

Consider adding explicit permissions declaration for security best practices. Since this workflow handles AWS/Akamai credentials, specify minimal required permissions.