Build failing on site with blog - 8.5.5-insiders-4.24.2

Contribution guidelines

• I’ve read the contribution guidelines and wholeheartedly agree

I’ve found a bug and checked that …

• … the documentation does not mention anything about my problem
• … there are no open or closed issues that are related to my problem

Description

When building with 8.5.5-insiders-4.24.2 the CI is broken.

Expected behaviour

The CI build without errors.

Actual behaviour

Run mkdocs gh-deploy --force --config-file mkdocs.yml
Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.10.7/x64/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/__main__.py", line 209, in gh_deploy_command
    cfg = config.load_config(
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/base.py", line 224, in load_config
    errors, warnings = cfg.validate()
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/base.py", line 108, in validate
    run_failed, run_warnings = self._validate()
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/base.py", line 63, in _validate
    self[key] = config_option.validate(value)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/config_options.py", line 132, in validate
    return self.run_validation(value)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/config_options.py", line 690, in run_validation
    plgins[item] = self.load_plugin(item, cfg)
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/mkdocs/config/config_options.py", line 703, in load_plugin
    Plugin = self.installed_plugins[name].load()
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/importlib_metadata/__init__.py", line 207, in load
    module = import_module(match.group('module'))
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/opt/hostedtoolcache/Python/3.10.7/x64/lib/python3.10/site-packages/material/plugins/search/plugin.py", line 42, in <module>
    class SearchPluginConfig(BasePlugin.config_class):
AttributeError: type object 'SearchPlugin' has no attribute 'config_class'

Steps to reproduce

I just pushed a new blog post and when using the previous tag it works.

Package versions

• Python: 3.10.7
• MkDocs: mkdocs-1.4.0
• Material: mkdocs-material-8.5.5+insiders.4.24.2

Configuration

site_name: Today I Learned
plugins:
  - search
  - social
  - privacy
  - tags
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - git-authors
  - blog:
      post_url_format: "{slug}"
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags
...

System information

CI running in a GitHub action:

name: ci 
on: push
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - uses: actions/cache@v2
        with:
          key: ${{ github.ref }}
          path: .cache
      - run: sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
      - run: pip install git+https://[e-mail]/squidfunk/mkdocs-material-insiders.git
      - run: pip install mkdocs-git-revision-date-localized-plugin
      - run: pip install mkdocs-git-committers-plugin-2
      - run: pip install mkdocs-git-authors-plugin
      - run: pip install pillow cairosvg
      - run: pip install mkdocs-rss-plugin
      - run: mkdocs gh-deploy --force --config-file mkdocs.yml

[Techbrunch]

I found the culprit:

mkdocs-rss-plugin 1.1.0 requires mkdocs<1.4,>=1.1, but you have mkdocs 1.4.0 which is incompatible.

I disabled the RSS plugin and now my build is passing \o/

My temporary fix:

      - run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@8.5.5-insiders-4.24.2
      - run: pip install mkdocs-git-revision-date-localized-plugin
      - run: pip install mkdocs-git-committers-plugin-2
      - run: pip install mkdocs-git-authors-plugin
      - run: pip install pillow cairosvg
      - run: pip install mkdocs-rss-plugin
      - run: pip install --force mkdocs==1.4.0
      - run: mkdocs gh-deploy --force --config-file mkdocs.yml
env:
  GH_TOKEN: ${{ secrets.GH_TOKEN }}

Looks like the rss plugin can safely used 1.4.0

[squidfunk]

The problems with the mkdocs-rss-plugin in the Docker image should be fixed in squidfunk/mkdocs-material-insiders@16a4cf8 and were released as 8.5.6+insiders-4.25.1. If you’re not using Docker, but pip, please upgrade the RSS plugin:

pip install --upgrade mkdocs-rss-plugin mkdocs