Skip to content

docs: update mkdocs-material requirement from >=9.8.0 to >=9.8.1 in /docs - #330

Merged
SamErde merged 1 commit into
mainfrom
dependabot/pip/docs/mkdocs-material-gte-9.8.1
Nov 16, 2026
Merged

SamErde merged 1 commit into
mainfrom
dependabot/pip/docs/mkdocs-material-gte-9.8.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Updates the requirements on mkdocs-material to permit the latest version.

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.8.1

[!WARNING]

Material for MkDocs reaches end of life on May 5, 2027. Critical fixes and security updates continue until that date.

We're continuing our work with Zensical, a maintained successor built by the team behind Material for MkDocs. It carries forward what we've learned from building documentation tools with this community, with Markdown authoring, a familiar design, and full control over your content. Zensical is Open Source and MIT-licensed.

You can evaluate Zensical alongside MkDocs using your existing mkdocs.yml. Check plugin compatibility and compare your pages, navigation, search, and customizations before switching. The classic theme variant preserves the appearance of Material for MkDocs. See the migration guide for the steps and current compatibility details.

Upcoming changes on November 5

  • Updated Docker base image to Alpine 3.24
  • Updated Docker image dependencies to fix vulnerabilities
  • Updated Node build-time dependencies to fix vulnerabilities
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.8.1 (2026-11-07)

  • Updated Docker base image to Alpine 3.24
  • Updated Docker image dependencies to fix vulnerabilities
  • Updated Node build-time dependencies to fix vulnerabilities

mkdocs-material-9.8.0 (2026-10-24)

This is primarily a security release. It raises dependency minimums to address known vulnerabilities. We recommend upgrading to this release and updating your dependency lockfiles.

Python 3.11 or newer is now required. Python 3.8–3.10 are no longer supported.

  • Updated Node build-time dependencies to fix vulnerabilities
  • Updated Python dependency minimums and required Python 3.11
  • Removed RSS from recommended dependencies
  • Updated project status and maintenance links
  • Updated CLI notice with end-of-life and migration guidance
  • Removed redirects from recommended dependencies

Previous dependency ranges allowed versions with known vulnerabilities. The new minimums cover core Python dependencies and the optional git and imaging extras, including GitPython 3.2.1 or newer for the git extra.

Recent releases of mkdocs-rss-plugin and mkdocs-redirects depend on ProperDocs, a separate static site generator that Material for MkDocs does not require. Removing these plugins from the recommended extra keeps its dependency footprint smaller and leaves the choice of additional tools to each project. If your project uses RSS feeds or redirects, declare the relevant plugin explicitly in your own dependencies.

The CLI notice now gives the May 5, 2027 end-of-life date and links to the Zensical migration guide: https://zensical.org/docs/compatibility/mkdocs/migration/

It also clarifies that third-party ProperDocs migration notices do not represent a recommendation from the Material for MkDocs team. Package metadata now marks the project as inactive and includes maintenance and migration links.

Selected Python security advisories addressed by the new minimums:

Jinja2: affected <=3.1.5; new minimum 3.1.6 (CVE-2025-27516) GHSA-cpwx-vrp4-4pq7

Markdown: affected <3.8.1; new minimum 3.8.1 (CVE-2025-69534) GHSA-5wmx-573v-2qwq

Pygments: affected <2.20.0; new minimum 2.20.0 (CVE-2026-4539) GHSA-5239-wwwm-4pmq

... (truncated)

Commits
  • 16c95ad Prepare 9.8.1 release
  • b3fe832 Fixed documentation workflow
  • 004d29e Updated dependencies to fix vulnerabilities
  • 7590e14 Documentation
  • 0f044db Updated documentation build to use public Material
  • dc38d1e Documentation
  • ebbfb46 Updated Docker base image to Alpine 3.24
  • 624aff1 Updated build and documentation workflows
  • See full diff in compare view

@dependabot
dependabot Bot requested a review from SamErde as a code owner November 15, 2026 19:22
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Nov 15, 2026
@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 66698cd3-27c4-4168-96d4-7d7b424b4431

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 15, 2026
@github-actions

github-actions Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA ee3e180.
Ensure that dependencies are being submitted on PR branches. Re-running this action after a short time may resolve the issue. See the documentation for more information and troubleshooting advice.

Scanned Files

None

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity ✅ 0 (≤ 100 complexity)

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@SamErde

SamErde commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Review: ready to approve and merge. This changes only the documentation dependency floor from mkdocs-material>=9.8.0 to >=9.8.1; the release notes identify 9.8.1 as a security/dependency-fix release, and the dependency-review plus all applicable PR checks pass. The module test matrix is skipped for this docs-only change. The MkDocs deployment workflow is push-triggered rather than a PR check, so a docs-site build is not evidenced on this PR; merge order is independent of the other safe docs update.

@SamErde

SamErde commented Nov 16, 2026

Copy link
Copy Markdown
Owner

@dependabot rebase

@SamErde

SamErde commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Review limitation: the dependency-review check is green, but its report states that no dependency snapshots were found and no files were scanned. Therefore it provides no resolved-dependency advisory coverage for this PR; the security rationale here is the upstream 9.8.1 release notes and the narrow minimum-version change. The PR also has no MkDocs build check because the docs deployment workflow only runs on pushes.

Updates the requirements on [mkdocs-material](https://github.com/squidfunk/mkdocs-material) to permit the latest version.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.8.0...9.8.1)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-version: 9.8.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot force-pushed the dependabot/pip/docs/mkdocs-material-gte-9.8.1 branch from c70ff75 to ee3e180 Compare November 16, 2026 15:01
@SamErde

SamErde commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Post-rebase status: Dependabot rebased this PR onto merge commit 855ea8b, and the Build gate plus compatibility-tooling check now pass. Dependency Review, Codacy, and CodeFactor are still in progress, so I’m deferring approval and merge until the fresh-head checks settle. The documentation build remains outside the PR workflow.

@SamErde SamErde left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved: the rebase is on current main, the Build gate, compatibility-tooling, and Dependency Review checks pass, and the change is limited to the documentation dependency floor. As noted in the review, dependency-review found no snapshots and the push-triggered MkDocs build is not run on PRs. CodeFactor is still pending, so merge remains conditional on its result and a clean mergeability state.

@SamErde

SamErde commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Update: after the rebase, Build gate, compatibility tooling, Dependency Review, and Codacy have passed, so I submitted approval. CodeFactor remains in progress and GitHub reports merge state unstable; I’m holding the merge until that check finishes and the PR is cleanly mergeable rather than bypassing the pending check.

@SamErde
SamErde merged commit 174e515 into main Nov 16, 2026
23 of 24 checks passed
@SamErde
SamErde deleted the dependabot/pip/docs/mkdocs-material-gte-9.8.1 branch November 16, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation python Pull requests that update python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant