Skip to content

tags_file deprecation, strict mode, and non-Insiders compatibility #7146

@kcgthb

Description

@kcgthb

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

  1. use tags_file
  2. build in strict mode

Browser

No response

Before submitting

Metadata

Metadata

Assignees

No one assigned

    Labels

    change requestIssue requests a new feature or improvementupstreamIssue must be taken upstream

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions