Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Split docs preview build and deploy workflows

Đang mở
  • Có gì không ổn?
#637 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
github-actions, python
Lĩnh vực
ci-cd, devops, documentation

Hướng nghiên cứu

Trước tiên, hãy đọc #622 và .github/workflows/docs-preview.yml, sau đó xác nhận deploy workflow khả dụng trên main. Đưa .github/workflows/docs-preview-deploy.yml trở lại, giữ build/check và tải artifact lên trong preview workflow. Hoàn thành khi một PR từ cùng repository cập nhật cả hai preview comment của MkDocs và Fern, trong khi các PR từ fork chỉ build và check.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
2.3k
Fork
211
Merge trung bình
3 ngày 12 giờ
Pull request đã merge (30 ngày)
45

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NVIDIA-NeMo/DataDesigner

Tất cả issue của NVIDIA-NeMo/DataDesigner

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.