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

Aperta
  • Qualcosa non va?
#27 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
62/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, python
Ambito
build-system, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Python
Stelle
2
Fork
5
Merge medio
2g 17h
PR unite (30g)
6

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Awesome-Ads

Tutte le issue di TMHSDigital/Awesome-Ads

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.