Skip to content

Releases: ojacques/mkdocs-git-committers-plugin-2

1.2.0

06 Sep 19:45
Compare
Choose a tag to compare
  • #31 - New: allow exclude files and paths. See documentation. Thanks @Fir121
  • #33 - Add lxml dependency. Fix #32. Thanks @Guts
  • #34 - Improve packaging. Thanks @Guts

1.1.2

27 Mar 20:29
Compare
Choose a tag to compare
  • Fix error when cache is incomplete
  • Fix for Windows users where path was incorrect - #26

1.1.0

07 Sep 22:06
Compare
Choose a tag to compare

New: cache file for authors to speed up documentation builds

1.0.2

02 Sep 08:52
5eb3c36
Compare
Choose a tag to compare

Fix #19 - build fails when file is not on GitHub or part of a Git submodule

1.0.1

01 Sep 12:17
1c35a3f
Compare
Choose a tag to compare

Fix missing beautifulsoup4 dependency.

1.0.0

31 Aug 20:35
92fb731
Compare
Choose a tag to compare

1.0.0 is a complete rewrite, with much simpler code now. The output is the same, but I still consider this a breaking change because of the completely new method. Hence version bump to 1.0.0.

  • Fetch contributors from GitHub directly, leveraging the unsupported http endpoint contributors-list which lists all contributors for a given file and parse that.
  • Fixes #7 as there is no more ambiguity possible with this new mechanism
  • Eliminate the need for a GitHub personal access token
  • Cache file introduced in 0.4.1 is removed. Which means there is no cache now, making this process linear with respects to how many documentation pages there are. To speed up the build, it is recommended to leverage the enabled boolean in plugin's mkdocs.yml and enable contributors for main/master branch builds only.

As I am leveraging an undocumented GitHub endpoint, there is a risk that this could break. Unfortunately, I could not find a way to this using a mix of GitHub GraphQL or REST API.

0.4.4

27 Aug 06:19
cf0879f
Compare
Choose a tag to compare

Fix #7: GitHub login is attempted before name.

0.4.3

28 Jun 19:27
Compare
Choose a tag to compare
  • Fix: do not attempt GitHub graphql when no token provided
  • Fix #11: cache file for authors could only be created once

0.4.2

26 Jun 22:17
Compare
Choose a tag to compare
  • new: Add cache_dir option to control directory to load/save authors.json
  • fix: Remove size for avatar attribute
  • doc: Add precision for GitHub token scope