Plan for Material for MkDocs end of life (2027-05-05) and pin build deps
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 62/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, python
调研方向
Start with requirements-docs.txt (the two pinned packages) and mkdocs.yml, then run mkdocs build --strict locally to see the end-of-life notice and confirm which plugins and hook entries matter (hooks:, scripts/mkdocs_hooks.py, pymdownx.snippets, exclude_docs). For the pinning half, freeze a clean venv into a constraints file and wire it with -c into the install steps of ci.yml and pages.yml. Done means both workflows install fully pinned versions and a written decision on Zensical versus staying is recorded on the issue.
由索引模型根据 Issue 内容生成。
描述
Summary
The site is built with mkdocs-material==9.8.1, which reaches end of life on 2027-05-05 (the build prints this notice). Plan the move to its successor before then. Separately, only the two top-level packages are pinned, so the rest of the build toolchain can change between runs.
Where
requirements-docs.txt:1-2
Details
mkdocs build --strict prints:
Material for MkDocs reaches end of life on May 5, 2027.
Critical fixes and security updates continue until that date.
Zensical is its maintained successor, built by the same team.
requirements-docs.txt pins mkdocs-material and mkdocs-git-revision-date-localized-plugin. Their dependencies (mkdocs, pymdown-extensions, Markdown, GitPython, and others) are unpinned.
Impact
After May 2027 the site generator gets no security or bug fixes. Unpinned transitive dependencies mean a CI run can break, or render differently, with no change in this repo.
Suggested fix
- Try Zensical's MkDocs compatibility mode against
mkdocs.yml. Things to check: thehooks:entry (scripts/mkdocs_hooks.py), thegit-revision-date-localizedplugin,pymdownx.snippets, andexclude_docs. - Decide on a target date before 2027-05-05 and record it in this issue.
- In the meantime, add a constraints file (for example
pip freeze > constraints-docs.txtfrom a clean venv) and install with-cinci.ymlandpages.yml, so builds are repeatable.
Acceptance criteria
- A migration plan or a decision to stay is recorded here.
- CI and Pages install from fully pinned versions.
Filed by repo-audit/full-audit at 79cb5dc. Severity: low. Effort: M. audit-key: dependencies|requirements-docs.txt|mkdocs-material
- 主要语言
- Python
- 星标
- 2
- 派生
- 5
- 平均合并
- 2 天 17 小时
- 30 天内合并 PR
- 6
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
TMHSDigital/Awesome-Ads 的其他 Issue
-
bug good first issue severity: low
难度 1/5 1-3 小时 新手友好度 85/100
TMHSDigital/Awesome-Ads#37 ·
维护者通常 1 天内回复
-
enhancement good first issue severity: low
难度 2/5 1-3 小时 新手友好度 75/100
TMHSDigital/Awesome-Ads#35 ·
维护者通常 1 天内回复
-
documentation help wanted severity: low
难度 2/5 半天 新手友好度 72/100
TMHSDigital/Awesome-Ads#29 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 62/100
TMHSDigital/Awesome-Ads#16 ·
维护者通常 1 天内回复
查看 TMHSDigital/Awesome-Ads 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 74/100
datamodel-code-generator/datamodel-code-generator#6906 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
UKGovernmentBEIS/optstop#12 ·
-
enhancement
难度 2/5 1-3 小时 新手友好度 72/100
smokin-salmon/smoked-salmon#1095 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 76/100
Sienna-Platform/SiennaSchemas#130 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
samuelcolvin/dirty-equals#146 ·