Plan for Material for MkDocs end of life (2027-05-05) and pin build deps

Đang mở
  • Có gì không ổn?
#27 1 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, python
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

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.

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

Mô tả

dependencies help wanted severity: low

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: the hooks: entry (scripts/mkdocs_hooks.py), the git-revision-date-localized plugin, pymdownx.snippets, and exclude_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.txt from a clean venv) and install with -c in ci.yml and pages.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

Ngôn ngữ chính
Python
Star
2
Fork
5
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
6

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 TMHSDigital/Awesome-Ads

Tất cả issue của TMHSDigital/Awesome-Ads

Issue tương tự

Thêm issue về Python

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.