nolebase / integrations

✍️ A collection of diverse documentation engineering tools. Better reading experience, inline link preview, highlight targeted title, enhanced <mark> element, state-of-the-art SEO and <meta> generation, og image, thumbhash & blurhash images and more!
https://nolebase-integrations.ayaka.io
MIT License
143 stars 26 forks source link

feature request(git-changelog): use github authors avatars by default #277

Closed northword closed 2 months ago

northword commented 2 months ago

Adding on this issue thread, it would be nice if github avatars of commit authors will be used by default instead of manually mapping authors in config.

Originally posted by @taskylizard in https://github.com/nolebase/integrations/issues/252#issuecomment-2253177129

northword commented 2 months ago

@northword was this even possible?

Of course, it's achievable. Until the plugin implements it, maybe it could be done by mapping the array in mapAuthors and specifying a username for it?

northword commented 2 months ago

@taskylizard In addition, this feature must address the question of what we what to use as a GitHub username. Without clarifying this, we might get the wrong user avatar.

What we have now is a manually configured username field in mapAuthors, which by default matches the GitHub avatar when it exists.

The username and email can be read from the Git history, however, in my experience, many of the usernames in the commit history are not Git platform (e.g. GitHub) usernames.

nekomeowww commented 2 months ago

@northword Implementation reference:

https://github.com/gitkraken/vscode-gitlens/pull/814

https://github.com/mhutchie/vscode-git-graph/commit/ee829d6c5ed826835d9b40a836063b5db72d8054

Related discussion:

https://github.com/gitkraken/vscode-gitlens/issues/281

https://github.com/gitkraken/vscode-gitlens/issues/1036

This looks quite complex to implement and support different data sources, and even valuable to have a dedicated package for more universal use cases.

nekomeowww commented 2 months ago

@northword Possibly related:

https://discord.com/channels/1229292283657195520/1229292844838162474/1245752865247727677