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.

Sign up for GitHub

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

Jump to bottom

GitHub username mentions for GitHub releases #116

Open
1 task done
danielroe opened this issue Jun 6, 2023 · 3 comments · May be fixed by #155
Open
1 task done

GitHub username mentions for GitHub releases #116

danielroe opened this issue Jun 6, 2023 · 3 comments · May be fixed by #155

Comments

@danielroe
Copy link
Member

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

  • Would you be willing to help implement this feature?
@pi0
Copy link
Member

pi0 commented Jun 7, 2023

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)

@danielroe Volta.net
Copy link
Member Author

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.

@pi0
Copy link
Member

pi0 commented Jun 7, 2023 •
edited
Loading

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.

@JohnCampionJr JohnCampionJr linked a pull request Oct 28, 2023 that will close this issue
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: lookup Github username if token is available JohnCampionJr/changelogen
2 participants
@pi0 @danielroe