search

timvink / mkdocs-git-revision-date-localized-plugin

MkDocs plugin to add a last updated date to your site pages
https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html
MIT License
206 stars 44 forks source link

Set fixed dependency version for GitPython #56

Closed miffels closed 3 years ago

miffels commented 3 years ago

Hey,

We've had an issue in our pipeline lately that appears to have been due to a combination of Python 3.7 on the build box and this plugin transitively pulling GitPython v3.1.20. The issue appears to be related to https://github.com/gitpython-developers/GitPython/issues/1095. We were able to resolve the issue by setting the last known working version, which was 3.1.19. It's now fixed for us since we added GitPython to our own project dependencies with that version, but this might help others avoid the issue altogether. Otherwise some sort of FAQ or troubleshooting/setup guide might be helpful where people should set their own reliable version for stable builds.

Cheers!

timvink commented 3 years ago

Thanks a lot for digging into this and providing a PR!

There are two choices here: 1) either I fixed dependencies, and on every update re-run the tests and deploy a new version (f.e. using dependabot). 2) I set a minimal version, trust downstream releases and let the user deal with problems should they arise.

I am going for 2), because of maintenance time mainly but also to avoid forcing users into specific versions.

It also turns out that GitPython yanked the faulty release in the meantime:

image

So, I will close this PR. I have opened https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/57 to make sure I am notified of these kinds of issues earlier however.