insider: git-committers shows GitHub, even for GitLab repositories

[ojacques]

Context

No response

Bug description

When using the mkdocs-git-committers-plugin-2 v2.1.0, which now supports GitLab repositories, the contributors are next to a GitHub logo and text.

I expect this to be GitLab logo and text.

Related links

• [Reporting a bug
  -](https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-contributors)
• GitLab Repository Integration: Plugin Not Adding committer details to UI ojacques/mkdocs-git-committers-plugin-2#28 (comment)

Reproduction

demo.zip

Steps to reproduce

1. Start a new mkdocs material site on gitlab
2. Activate the committers plugin:

plugins:
  - git-committers:
      gitlab_repository: 12345678
      token: !ENV ["GH_TOKEN"]

3. Render the site
4. At the bottom of the page, see GitHub logo and text

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction.

[squidfunk]

Thanks for reporting. How can we distinguish this in the template? We need some way to decide what icon to show with a simple {% if %}...{% else %} condition. See the relevant section here (Insiders).

[ojacques]

I was thinking that checking author.url for github or gitlab would work. But for self-hosted GitHub or GitLab, you can't be sure that the url will contain github or gitlab.
Is that OK for you if I add a source field (author.source) to the author object, and make it either github or gitlab?

[squidfunk]

Is that OK for you if I add a source field (author.source) to the author object, and make it either github or gitlab?

Sounds perfect! Once that's implemented, we can directly make the necessary changes – it's just changing an icon and a description after all.

[ojacques]

Done in mkdocs-git-committers-plugin-2 2.2.0.

[squidfunk]

Thanks! I'm not sure how to use it. Is source defined per author? That's kind of weird, because we would need to hoist the value then, and it is the same for all authors, isn't it? Our templates are like this:

SOURCE
each AUTHOR of AUTHORS
  AUTHOR

Maybe I've misread ojacques/mkdocs-git-committers-plugin-2@1c1ff87, but that's how I understand it.

[ojacques]

Hmmm. I thought it was easier for you to have source repeated for all authors (although, I agree it does not make sense, it is the same for all authors of a given repo).
I will hoist source up in the context, in committers-source (I don't want to override another potential source).

[ojacques]

Done in https://github.com/ojacques/mkdocs-git-committers-plugin-2/releases/tag/2.2.1.
committers-source equals github or gitlab.

[squidfunk]

Sorry to bother again, but as far as I know, a variable cannot include - in its name. At least I don't know how to reference them in templates. I would recommend switching to _. I've never seen variables using - 😉 Error:

...
    {% if committers-source == "gitlab" %}
^^^^^^^^^^^^^^^^^^^^^^^^^
jinja2.exceptions.UndefinedError: 'source' is undefined

[squidfunk]

I've made all changes, took the opportunity to modularize the template (to make it ready for more integrations with git-related plugins) and pushed everything in 3b7632a. If you switch committers-source to committers_source it should work right away. The default is that it falls back to GitHub, so it will also work with older versions of the plugin 🚀

[ojacques]

All set in 2.2.2.
Thanks!

[squidfunk]

Released as part of 9.4.8+insiders-4.43.0.