ENH: standalone execution check of built notebooks

Đang mở
  • Có gì không ổn?
#2 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
anaconda, github-actions, jupyter, shell
Lĩnh vực
build-system, ci-cd, testing-qa

Hướng nghiên cứu

Bắt đầu bằng cách đọc templates/cache.yml, build-jupyter-cache/action.yml và build-lectures/action.yml, sau đó xem lại PLAN.md và phần công việc được liên kết của #92 Phase 3. Mục tiêu là một workflow cache hằng tuần bảo đảm các notebook _build/jupyter tồn tại, thực thi từng notebook trong container được ghim phiên bản, báo cáo kết quả theo từng bài giảng và có chính sách đã thống nhất về lỗi cũng như cảnh báo.

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

Mô tả

enhancement low-priority

A lecture can build cleanly and still break for a reader who downloads it. Benefit: match running a lecture standalone.

The gap is the artifact, not kernel isolation — jupyter-cache already isolates kernels per notebook (single_nb_execution). Download/Colab notebooks come from sphinx-tojupyter (containers/quantecon-build/environment.yml:67) via the jupyter builder (build-lectures/action.yml:104, output :126, staged to _build/html/_notebooks :71-76), and nothing here executes them, so conversion defects ship silently. Scope is executing them (PLAN.md:117); both options first floated are dated — a venv off a base anaconda image fights the pinned-as-a-set policy (PLAN.md:96-102), and the preferred jupyter-book/MyST-NB/myst-parser engine runners were never pursued upstream.

Work items

  • Weekly cache workflow (templates/cache.yml:22, 0 0 * * 0): execute each _build/jupyter/**.ipynb in the pinned container, report per-lecture pass/fail
  • Ensure notebooks exist: jupyter builds only when requested (build-jupyter-cache/action.yml:162, built :160-166) and the template ships builders: 'html' with jupyter commented (templates/cache.yml:73-75), so require jupyter or build them
  • Settle the runtime budget for re-executing every lecture weekly; may depend on #92 Phase 3's parallel pre-execution
  • Decide whether failure blocks the cache save or only reports
  • Alerting: build-jupyter-cache's failure-issue path is inline actions/github-script (build-jupyter-cache/action.yml:382-528), so a new job must extract or duplicate it
  • Resolve the "first step of #2" conflict: #92 Phase 3 and PROJECT-OPTIMIZE-PREVIEWS.md:93 both claim it for the jcache project execute --executor local-parallel pilot — a wall-clock optimisation, not an artifact check. Proposal: #92 drops the lineage, this issue keeps the notebook check.
Ngôn ngữ chính
Shell
Star
0
Fork
1
Merge trung bình
20 giờ 3 phút
Pull request đã merge (30 ngày)
48

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 QuantEcon/actions

Tất cả issue của QuantEcon/actions

Issue tương tự

Thêm issue về Shell/Bash

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.