-
Notifications
You must be signed in to change notification settings - Fork 4.1k
tags_file deprecation, strict mode, and non-Insiders compatibility #7146
Copy link
Copy link
Closed
Labels
change requestIssue requests a new feature or improvementIssue requests a new feature or improvementupstreamIssue must be taken upstreamIssue must be taken upstream
Description
Context
mkdocs 1.6.0
mkdocs-material 9.5.20+insiders.4.53.8
Bug description
The new tags_file deprecation prevents building sites in strict mode. But removing that option breaks compatibility with non-Insiders builds.
Related links
Reproduction
With the following recommended configuration in mkdocs.yml:
- tags:
tags_file: docs/tags.md
building the site in strict mode now fails, because of the deprecation warning:
$ mkdocs build -s
WARNING - Config value 'plugins': Plugin 'material/tags' option 'tags_file': The configuration option 'tags_file' has been deprecated and will be removed in a future release.
Aborted with 1 configuration warnings in 'strict' mode!
But removing that option is not really possible, as it would break the tag index functionality for non-Insiders builds.
How can we continue to build in strict mode (especially to catch errors in CI/CD scenarios) while retaining compatibility between Insiders and regular builds?
Steps to reproduce
- use
tags_file - build in strict mode
Browser
No response
Before submitting
- I have read and followed the bug reporting guidelines.
- I have attached links to the documentation, and possibly related issues and discussions.
- I assure that I have removed all customizations before submitting this bug report.
- I have attached a .zip file with a minimal reproduction using the built-in info plugin.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
change requestIssue requests a new feature or improvementIssue requests a new feature or improvementupstreamIssue must be taken upstreamIssue must be taken upstream