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

Use GitHub username? #132

Closed
max-sixty opened this issue Dec 27, 2022 · 5 comments
Closed

Use GitHub username? #132

max-sixty opened this issue Dec 27, 2022 · 5 comments
Assignees
@orhun
Labels
feature/request New feature or request

Comments

@max-sixty
Copy link

max-sixty commented Dec 27, 2022 •
edited
Loading

Is your feature request related to a problem? Please describe.

This might be asking too much, but currently the changes in #100 use the author in the git commit, which is frequently an unfriendly noreply email; e.g.:

- Sync our main example across readme & book (#1112)- Maximilian Roos <[email protected]> 2022-11-05

- Update ci badge link (#124)- Kyle Wigley <[email protected]> 2022-02-24

Describe the solution you'd like

We'd want the GitHub usernames — I imagine this would be highly preferable for most projects...

Describe alternatives you've considered

Ironically the unfriendly [email protected] could be parsed into @max-sixty. But where they're not masked, possibly it would be necessary to query GitHub for them?

Ref PRQL/prql#736
@max-sixty max-sixty added the feature/request New feature or request label Dec 27, 2022
@max-sixty max-sixty mentioned this issue Dec 27, 2022
Closed
@orhun
Copy link
Owner

orhun commented Dec 29, 2022

Hello!

Unfortunately I won't be adding specific GitHub-related features to git-cliff. I briefly mentioned this in #112:

It is always good to refrain from adding code-hosting related things to git-cliff since it is not specifically designed to work with e.g. GitHub, GitLab, etc. These remote URLs might change any time depending on which platform you are using. git-cliff should only integrate well with git and it should be configurable based on user liking.

I suggest you update your committer details accordingly to your GitHub account:

git config --global user.name "John Doe"
git config --global user.email "[email protected]"

But where they're not masked, possibly it would be necessary to query GitHub for them?

Yes, that's why it will complicate things further.

Thank you for the suggestion! 🐻

@orhun orhun closed this as completed Dec 29, 2022
@max-sixty
Copy link
Author

max-sixty commented Dec 29, 2022 •
edited
Loading

Thanks @orhun ; that makes sense — both the additional complication and the GH specificity.

FWIW if you can think of another way of achieving something like this; e.g. a config file with a lookup from email to handle which the changelog generation could then use, that would be quite nice. If I do a quick survey of changelogs, almost all use GH handles. And while I'm no fan of hegemony, GH do have one in open-source projects...

Thanks again for the excellent tool!

@tqwewe
Copy link

tqwewe commented Mar 15, 2023

I'd love to see this! Something where it looks up the username from emails would be amazing.

@PSeitz PSeitz mentioned this issue Apr 13, 2023
Merged
12 tasks
PSeitz added a commit to PSeitz/git-cliff that referenced this issue Apr 13, 2023
@PSeitz
feat: add postprocessors to changelog
127137e 
This will enable things like replacing usernames with github usernames orhun#132
PSeitz added a commit to PSeitz/git-cliff that referenced this issue Apr 19, 2023
@PSeitz
feat: add postprocessors to changelog
b9b4924 
This will enable things like replacing usernames with github usernames orhun#132
PSeitz added a commit to PSeitz/git-cliff that referenced this issue Apr 20, 2023
@PSeitz
feat: add postprocessors to changelog
e5fd555 
This will enable things like replacing usernames with github usernames orhun#132
orhun added a commit that referenced this issue Jun 10, 2023
@PSeitz @orhun
feat(changelog)!: add postprocessors (#155)
5dc5fb7 
BREAKING: `CommitPreprocessor` is renamed as `TextProcessor`

* feat: add postprocessors to changelog

This will enable things like replacing usernames with github usernames #132

* review comments

* refactor(clippy): apply clippy suggestions

* refactor(postprocessors): polish the implementation

* docs(postprocessors): update documentation about GitHub usernames

* style(format): update formatting

---------

Co-authored-by: Orhun Parmaksız <[email protected]>
@orhun orhun mentioned this issue Dec 2, 2023
Merged
12 tasks
@orhun
Copy link
Owner

orhun commented Dec 3, 2023

I doubled down on this and created a PR for GitHub integration: #363

@orhun
Copy link
Owner

orhun commented Dec 26, 2023

You can now achieve this with the GitHub integration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orhun orhun

Labels
feature/request New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@max-sixty @tqwewe @orhun