Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#307 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
1-2 天
新手友好度
53/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
github, github-actions, yaml
领域
ci-cd

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
TeX
星标
5
派生
4
平均合并
6 天 22 小时
30 天内合并 PR
20

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

QuantEcon/lecture-python.zh-cn 的其他 Issue

查看 QuantEcon/lecture-python.zh-cn 的全部 Issue

相似的 Issue

更多 DevOps Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。