Split docs preview build and deploy workflows

オープン
#637 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
静か
技術スタック
github-actions, python

調査の方向性

まず #622 と .github/workflows/docs-preview.yml を読み、その後 deploy workflow が main で利用可能であることを確認します。.github/workflows/docs-preview-deploy.yml を再導入し、preview workflow には build/check と artifact upload を残します。同一リポジトリからの PR では MkDocs と Fern の両方の preview コメントが更新され、fork からの PR では build と check のみが実行されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation task
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.

主要言語
Python
スター
2.4k
フォーク
241
平均マージ
21時間 51分
マージ済み PR(30日)
90

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NVIDIA-NeMo/DataDesigner のほかの issue

NVIDIA-NeMo/DataDesigner の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。