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

PR previews show main's cached pages instead of the pull request's changes

Đang mở
  • Có gì không ổn?
#307 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
1-2 ngày
Mức phù hợp với người mới
53/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, github-actions, yaml
Lĩnh vực
ci-cd

Hướng nghiên cứu

Read ci.yml and compare its “Clear stale Sphinx environment” step with the corresponding step in publish.yml; the issue identifies the missing _build/html cleanup and gives the intended command. Check how the preview links are configured in Netlify and the CI workflow, then validate on a PR that edits an existing lecture: its preview should show the change and each PR should have one working preview link.

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

Mô tả

What happens

A pull request's Netlify preview does not show the pull request's changes to an existing lecture. The Build HTML step in ci.yml writes a page only when that lecture has no page in the downloaded build cache, so every other page in the preview is the cached copy built from main.

Evidence from #304, which changed var_dmd.md and measurement_models.md:

  • Its CI run (Actions run 39720429073) wrote six pages: gallant_tauchen, intro, lq_mean_field_games, lucas_prescott_investment, optimal_growth_uncertainty and social_security_depletion. Neither changed lecture was among them.
  • On the preview it deployed, var_dmd.html contains 113 of the 114 phrases the PR removed and 6 of the 154 it added. The page shows the old translation.

#305's preview of sir_model looked right only by coincidence. Its run did not rewrite that page either, but the cache predated #302, so it already held the wording #305 restored.

Cause

The Clear stale Sphinx environment step removes _build/.doctrees but leaves the cached _build/html. The notebook build then reads every source and saves the shared Sphinx environment, so the HTML build reads nothing (updating environment: 0 added, 0 changed, 0 removed) and writes a page only if its source file is newer than the cached HTML file. The cache is unpacked after checkout, so the cached HTML always looks newer.

publish.yml does not have this problem. Its clear step removes both directories, and the publish-2026oct22 run wrote all 150 pages.

What to change

  1. In ci.yml, make the clear step remove _build/html as well, matching publish.yml:
      - name: Clear stale Sphinx environment
        shell: bash -l {0}
        run: rm -rf _build/.doctrees _build/html

The execution cache (_build/.jupyter_cache) is kept, so no notebook re-executes. The HTML step then writes all 150 pages.

  1. Remove the second, broken preview link. Netlify's own app also comments on each PR ("Deploy Preview for astonishing-narwhal-a8fc64 ready!"), and its deploy-preview-N link returns 404 (checked 2026-10-23 on #304 and #305). The working preview is the later github-actions comment ("🚀 Deployed on …"). Turn off deploy previews for this site in Netlify's settings, so the CI deploy is the only one.

  2. Optional: replace nwtgck/actions-netlify with quantecon/actions/[email protected], as QuantEcon/lecture-python-programming.fr does. It posts a stable pr-N URL and a link to each lecture the PR changes, which is the page a reviewer opens. It needs pull-requests: write on the job and a Node setup step, as in the fr ci.yml. On QuantEcon/lecture-python-programming.fr#94 its preview shows the PR's text.

Done when

  • A PR that edits an existing lecture shows the edited text in its preview, checked on one PR.
  • Each PR carries one preview link, and it works.
Ngôn ngữ chính
TeX
Star
5
Fork
4
Merge trung bình
6 ngày 22 giờ
Pull request đã merge (30 ngày)
20

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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/lecture-python.zh-cn

Tất cả issue của QuantEcon/lecture-python.zh-cn

Issue tương tự

Thêm issue về DevOps

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.