Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
northword opened this issue Jul 27, 2024 · 4 comments · Fixed by #293
Closed

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

northword opened this issue Jul 27, 2024 · 4 comments · Fixed by #293
Labels
difficulty/hard Hard to deal with / implement against enhancement New feature or request pkg/git-changelog Related to @nolebase/vitepress-plugin-git-changelog

Comments

@northword
Copy link
Member

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 #252 (comment)

@northword northword added enhancement New feature or request pkg/git-changelog Related to @nolebase/vitepress-plugin-git-changelog difficulty/medium Medium level to deal with / implement against labels Jul 27, 2024
@northword
Copy link
Member Author

northword commented Jul 27, 2024

@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
Copy link
Member Author

@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
Copy link
Member

@northword Implementation reference:

gitkraken/vscode-gitlens#814

mhutchie/vscode-git-graph@ee829d6

Related discussion:

gitkraken/vscode-gitlens#281

gitkraken/vscode-gitlens#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.

@northword northword added difficulty/hard Hard to deal with / implement against and removed difficulty/medium Medium level to deal with / implement against labels Jul 27, 2024
@nekomeowww
Copy link
Member

nekomeowww commented Jul 27, 2024

@northword Possibly related:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty/hard Hard to deal with / implement against enhancement New feature or request pkg/git-changelog Related to @nolebase/vitepress-plugin-git-changelog
Projects
None yet
2 participants