NVIDIA-NeMo / NVIDIA-NeMo/DataDesigner

Split docs preview build and deploy workflows

Open
#637 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation task
Dominant language
Python
Stars
2.2k
Forks
211
Avg merge
2d 6h
Merged PRs (30d)
40

Description

Priority Level

Medium

Task Summary

Split docs preview into separate build/check and deploy workflows once the Fern migration PR lands, so PRs can validate docs artifacts without exposing deployment secrets to the PR workflow.

Technical Details & Implementation Plan
  • Move hosted preview publishing back out of .github/workflows/docs-preview.yml into a workflow_run deploy workflow after the deploy workflow exists on main.
  • Keep docs-preview.yml responsible for checkout, docs deps, source-only notebook conversion from docs/notebook_source/*.py, MkDocs build, and make check-fern-docs.
  • Upload site/, fern/, and preview metadata as an artifact.
  • In the deploy workflow, download the artifact for successful same-repo PR runs, run Fern preview with DOCS_FERN_TOKEN, deploy MkDocs to Cloudflare, and update the PR comment.
  • Preserve fork behavior: build and check only, no hosted preview.
Investigation / Context

During #622, the split was implemented but rolled back because workflow_run workflows only execute from the default branch. Since the new deploy workflow did not exist on main, the hosted preview did not update on the same PR. #622 now keeps deploy inline so its preview can update.

Agent Plan / Findings

Follow-up after #622 merges:

  1. Reintroduce .github/workflows/docs-preview-deploy.yml.
  2. Remove deploy/comment steps from .github/workflows/docs-preview.yml.
  3. Verify a subsequent PR updates both MkDocs and Fern preview comments.
  4. Consider making Fern preview failure non-blocking or clearly reported, matching current inline behavior.
Dependencies

Depends on #622 merging, or another bootstrap PR that lands the deploy workflow on main first.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read #622 and .github/workflows/docs-preview.yml first, then confirm the deploy workflow is available on main. Reintroduce .github/workflows/docs-preview-deploy.yml, keeping build/check and artifact upload in the preview workflow. Done when a same-repository PR updates both MkDocs and Fern preview comments while fork PRs only build and check.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, devops, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.