-
Notifications
You must be signed in to change notification settings - Fork 3.3k
fix(deps): upgrade mkdocs-material
from 8.2.6 to 9.x
#12894
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(deps): upgrade mkdocs-material
from 8.2.6 to 9.x
#12894
Conversation
- [8.2.6](https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.6) is 2 years old now - and there hasn't been an 8.x release since [9.0.0](https://github.com/squidfunk/mkdocs-material/releases/tag/9.0.0) was released 1.5 years ago - in particular, there are some CVEs in transitive deps of `mkdocs-material` now (such as `urllib3` CVEs: [GHSA-g4mx-q9vg-27p4](GHSA-g4mx-q9vg-27p4), [GHSA-hmv2-79q8-fv6g](GHSA-hmv2-79q8-fv6g), [GHSA-v845-jxx5-vc9f](GHSA-v845-jxx5-vc9f), etc) - so make the upgrade to 9.x - none of the removals in 9.0.0 affect our usage - main noticeable changes I can see are some CSS improvements - also remove fixed dep pins in `requirements.txt` and use a range - ideally we should use [`poetry`](https://github.com/python-poetry/poetry/) or similar and create a lockfile, but that's a separate topic with many more changes Signed-off-by: Anton Gilgur <[email protected]>
Noting that both are supported by dependabot, as well as I was considering I prefer |
Oh I apparently haven't done a deep-dive on Python builds in a bit. With PEP 517 build backends were fully split (see also Need to do some more testing but working on that for a future PR. |
mkdocs-material
from 8.2.6 to 9.xmkdocs-material
from 8.2.6 to 9.x
Signed-off-by: Anton Gilgur <[email protected]> (cherry picked from commit 40eb51e)
Backported cleanly to |
OpenSSF Scorecard is still detecting these Python CVEs, so I think it's actually finding them in the Python SDK, which does use |
Partial fix for #12031, "Vulnerabilities"
Motivation
mkdocs-material
now (such asurllib3
CVEs: GHSA-g4mx-q9vg-27p4, GHSA-hmv2-79q8-fv6g, GHSA-v845-jxx5-vc9f, etc)Modifications
make the upgrade to 9.x in
docs/requirements.txt
also remove fixed dep pins in
docs/requirements.txt
and use a rangepoetry
or similar and create a lockfile, but that's a separate topic with many more changes required -- this PR is focused on the upgradeVerification
make docs
open site/index.html
Took a look around, all seemed well to me. Mermaid plugin works, Field Reference with
md_in_html
works, admonitions workNotes to Reviewers
mkdocs-material
8.x rangeurllib3
etc without touchingmkdocs-material
Future Work
[ ] Add
poetry
orPipfile
config and a lockfile