Skip to content

每轮构建刷新页面最近提交信息的缓存 - #699

Open
cflorlfc wants to merge 2 commits into
OpenHUTB:masterfrom
cflorlfc:fix/provenance-cache-per-build
Open

cflorlfc wants to merge 2 commits into
OpenHUTB:masterfrom
cflorlfc:fix/provenance-cache-per-build

Conversation

@cflorlfc

@cflorlfc cflorlfc commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

变更内容

页面最近提交信息使用全局 _last_commit_cache,但没有在下一轮构建时失效。MkDocs serve 复用 hook 模块时,即使文件已有新提交,页面仍可能显示旧作者、日期和提交;未提交页面的 None 结果也会一直被缓存。

  • 在 on_pre_build 开始时清空缓存,保留同轮构建内的查询复用。
  • 新增三个使用真实临时 Git 仓库的 unittest:同轮只查询一次 Git;下一轮新提交刷新作者、日期和哈希;缓存过 None 的页面提交后恢复显示。
  • 测试使用固定的提交日期,并包含当前上游构建需要的社区文件夹具,不新增依赖。

已将上游 master 的 bfc8a01fb9c9e82f6aa69ea79db63d4627731b2d 通过普通合并提交同步到本分支,保留上游的 GENERATED_DOC_FILES 映射、社区文档复制、编辑链接及出处映射和行为准则测试。相对该上游基线,本 PR 仍只修改 hooks.py 和 tests/test_hooks.py。

生命周期依据:MkDocs hooks 文档。

关联 Issue:无。本次修复页面作者信息的缓存问题,与贡献指南复制告警的既有修复独立。

变更范围

  • 文档内容(markdown)
  • 配置 / 批处理 / 脚本
  • 其他:对应的 Python unittest 回归测试

自查清单

  • 仅包含与本次变更相关的文件(无夹带修改)
  • 涉及链接 / 图片路径的目标均已确认存在
  • 配置 / 脚本格式正确,并已在本地验证

实际验证

2026-11-18 重新验证,基线为上游 master 的 bfc8a01fb9c9e82f6aa69ea79db63d4627731b2d,修复提交为 49f798caf3d27deb6ff68cf87cb8ec1978ce1b24。

  • 将同一组缓存回归测试加载到未修改的上游 hooks.py:3 项中 1 项通过、2 项失败,分别复现旧提交信息未刷新、首次提交后仍显示为空的问题。
  • 修复后运行 python -X utf8 -B -m unittest discover -s tests -p test_hooks.py -k cache -v:3 项通过。
  • 运行 python -X utf8 -B -m unittest discover -s tests -v:本分支 72 项通过;同一环境的上游基线 69 项通过,均无跳过或失败。
  • 上游基线和本分支的 MkDocs 普通构建均退出 0;严格构建均退出 1,原因都是相同的三条未知引用键告警:OpenHUTB、article、100。没有新增告警,严格构建未通过。
  • git diff --check upstream/master 通过;无冲突标记;预留的五个文档相对上游没有差异。

上述命令使用现有虚拟环境 Python;仅为本次进程将 Windows TEMP / TMP 指向工作区临时目录,未修改仓库配置或系统权限。测试通过真实 Git 提交和同进程多轮钩子调用验证缓存生命周期,未实际启动完整浏览器预览会话。


社区协作提示:本 PR 仅修改 hooks.py 及其回归测试。

@cflorlfc cflorlfc changed the title fix: 每轮构建刷新页面最近提交信息的缓存 每轮构建刷新页面最近提交信息的缓存 Nov 15, 2026
@153sfd

153sfd commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

有冲突

Preserve upstream generated community document handling while refreshing provenance once per build. Adapt the regression fixture to include the code of conduct source.
@cflorlfc

Copy link
Copy Markdown
Contributor Author

@153sfd 冲突已修复并推送,感谢提醒。

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants