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

Abierto
  • ¿Algo no está bien?
#27 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
62/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github-actions, python
Área
build-system, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Python
Estrellas
2
Forks
5
Merge medio
2 d 17 h
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/Awesome-Ads

Todos los issues de TMHSDigital/Awesome-Ads

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.