Social plugin maintenance for MkDocs 1.5.0#5759
Conversation
|
I hope I wasn't too much pre-emptive... 🙋 let me know if I should draft this PR to avoid a premature merge 😵 |
|
Thanks for the PR! I assume you tested that the plugin still works? We definitely need to add tests at some point, but currently, it's necessary to test changes manually. |
|
I did check it with 1.5.0 (the newest commit of MkDocs). |
|
Perfect, thanks for the explanation and thanks for your work! We'll merge it as soon as MkDocs 1.5.0 is released. I understand that without merging it, everything will keep working as expected, except there are now deprecation warnings printed to stdout. That's absolutely fine. |
Actually, this statement turned out to be incorrect, because I had to implement support for both 1.5.0 and <1.5.0 in the I still think that there is no need for this kind of conditional in this project as you decide on which version of MkDocs you depend on. I just thought that the other method is worth mentioning ✌️ |
|
MkDocs 1.5.0 is out. We'll be updating to MkDocs >= 1.5.0 as it's out now and release a bugfix release shortly. Material for MkDocs 9.2.x will also depend on MkDocs 1.5.0 and will be considered stable soon. |
|
Great, then I will just open this PR again and let you decide when to merge it 💪 |
|
Thanks again! We'll issue 9.1.20 and 9.2.0b2 in a moment. |
|
@squidfunk mkdocs-material/requirements.txt Line 24 in 39580db pip typically installs the newest package if there is >=, so in this case 1.5.0, but if a user has MkDocs 1.4.2 or 1.4.3 already installed on their system doing a pip install mkdocs-material would keep the 1.4.2 version, as the dependency list still allows for 1.4.2.In this case of events users will get errors using the social plugin: if theme.custom_dir:
^^^^^^^^^^^^^^^^
AttributeError: 'Theme' object has no attribute 'custom_dir'
I said that previously, because I expected you'd update the dependency in the |
|
Hmm, okay, so I misunderstood this then. What I did: I merged your PR and tested with MkDocs 1.4.3 (which I had on my system) if the build still works when I add the social plugin – all good. Then, I merged the PR, as I assumed that it's backward compatible. I think it was because I had a fresh cache. We'll bump 9.1 to MkDocs 1.5.0 then and issue a new release. |
Hi 👋 ,
after MkDocs 1.5.0 releases and you upgrade the dependency, the
config.user_configsproperty will be marked as deprecated and will trigger a warning message.Just a pre-emptive maintenance commit ✌️