changelogen icon indicating copy to clipboard operation
changelogen copied to clipboard

GitHub username mentions for GitHub releases

Open danielroe opened this issue 2 years ago • 3 comments

Describe the feature

I would really like to be able to mention users when making a GitHub release. (This does not work if their user name is linked.)

For the GitHub release only, would it be possible to include just the username and not the link to their profile (which will be auto-linked)?

I would also note that quite a lot of usernames are not correctly linked, including mine. Currently I manually go through every commit to ensure I have the right user mentioned in the release. Here's a sample implementation from the amazing changelogithub:

https://github.com/antfu/changelogithub/blob/main/src/github.ts#L63-L93

Additional information

  • [X] Would you be willing to help implement this feature?

danielroe avatar Jun 06 '23 21:06 danielroe

We use same api to query users from their email actually but partially works.

I like the idea of grabbing @{username} pattern from commit message/description and add to credits. (in case of GitHub provider we can also lookup for full name from username might be more stable)

pi0 avatar Jun 07 '23 09:06 pi0

The linked code doesn't grab it from the commit message but directly uses the linked GitHub account login. This works around the issue with 'looking up' an account by email address which doesn't seem to be 100% reliable.

danielroe avatar Jun 07 '23 09:06 danielroe

Email lookup is indeed not precise but username lookup from github api might be (and also easier to cache than getting commit info from GitHub remote).

Still i am 👍🏼 to introduce this feature as opt-in to rely on github commits api.

pi0 avatar Jun 07 '23 10:06 pi0