Plan for Material for MkDocs end of life (2027-05-05) and pin build deps
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 62/100
- Issue-Typ
- Refactoring
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- github-actions, python
- Bereich
- build-system, documentation
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Python
- Sterne
- 2
- Forks
- 5
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 6
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TMHSDigital/Awesome-Ads
-
bug good first issue severity: low
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 85/100
TMHSDigital/Awesome-Ads#37 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement good first issue severity: low
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
TMHSDigital/Awesome-Ads#35 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation help wanted severity: low
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 72/100
TMHSDigital/Awesome-Ads#29 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 62/100
TMHSDigital/Awesome-Ads#16 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in TMHSDigital/Awesome-Ads
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
alltheplaces/alltheplaces#20570 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 1 Tag
-
area:ci bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
catincloud-labs/dagster-dex#206 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
number_to_words raises ValueError with threshold= for ordinals ("12th") and comma-grouped strings ("1,000")Evtl. vergeben @hemtilva hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 1 Tag
-
providers security
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
agentbreeder/agentbreeder#1031 ·
Maintainer antworten meist innerhalb von 1 Tag